chore: adding agents.md for copilot #676
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jaydip Gabani <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for GitHub Copilot agents working with the OPA Gatekeeper Library project. The documentation provides detailed instructions for understanding the project structure, build processes, and development workflows.
- Adds agent-specific documentation covering project overview, build commands, and development workflows
- Documents dual-engine policy support (Rego and CEL) with specific testing procedures
- Provides comprehensive troubleshooting and validation command sequences
Signed-off-by: Jaydip Gabani <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Jaydip Gabani <[email protected]>
sozercan
reviewed
Sep 8, 2025
Comment on lines
+304
to
+307
| - **Performance-critical policies** (CEL is faster) | ||
| - **Simple validation logic** (CEL syntax is more straightforward) | ||
| - **Kubernetes-native deployments** (CEL doesn't require OPA runtime) | ||
| - **Future-proofing** (CEL is Kubernetes' strategic direction) |
There was a problem hiding this comment.
i don't think these are needed since we always want to add for non-referential and non-external data
sozercan
reviewed
Sep 8, 2025
| # Run policy tests (requires OPA and gator CLI) | ||
| ./test.sh | ||
| make verify-gator-dockerized POLICY_ENGINE=rego | ||
| make verify-gator-dockerized POLICY_ENGINE=cel |
There was a problem hiding this comment.
Since we default to cel now, I think its a good idea to keep this so the changes are tested for both regardless to make sure error rate is kept as low as possible.
sozercan
approved these changes
Sep 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Which issue(s) does this PR fix (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when the PR gets merged):Fixes #
Special notes for your reviewer: