Skip to content

docs: contributing and readme update#84

Merged
KT-Doan merged 3 commits intomainfrom
docs/update_docs
Mar 3, 2026
Merged

docs: contributing and readme update#84
KT-Doan merged 3 commits intomainfrom
docs/update_docs

Conversation

@KT-Doan
Copy link
Collaborator

@KT-Doan KT-Doan commented Mar 3, 2026

Description

Updating Docs

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • I have read the CONTRIBUTING guide
  • My code follows the existing code style
  • I have added tests that prove my fix/feature works
  • I have updated documentation as needed
  • All new and existing tests pass (make test)
  • I have run the linter (make format)

@KT-Doan KT-Doan self-assigned this Mar 3, 2026
Copilot AI review requested due to automatic review settings March 3, 2026 09:07
@KT-Doan KT-Doan added the documentation Improvements or additions to documentation label Mar 3, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates contributor-facing documentation and the local pre-commit hook to reflect current development workflows for the Terraform Ory provider.

Changes:

  • Align README/CONTRIBUTING guidance with Makefile targets (deps, format, test-short, sec-trivy) and clarify .env usage for acceptance tests.
  • Update local dev override instructions to use the ory/ory provider source.
  • Adjust .githooks/pre-commit messaging and golangci-lint discovery order.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
README.md Updates requirements, acceptance-test env var guidance, and local/CI check commands.
CONTRIBUTING.md Refreshes dev setup steps, test instructions, feature-flag notes, and pre-commit checklist.
.githooks/pre-commit Updates formatting hint and changes how golangci-lint is located/executed.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@KT-Doan KT-Doan merged commit 760bea9 into main Mar 3, 2026
11 checks passed
@KT-Doan KT-Doan deleted the docs/update_docs branch March 3, 2026 10:05
KT-Doan added a commit that referenced this pull request Mar 4, 2026
docs: contributing and readme update
KT-Doan added a commit that referenced this pull request Mar 4, 2026
docs: contributing and readme update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants