Add copilot instructions for creating OpenFGA models #61
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughA new documentation file, Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
.github/copilot-instructions.md (6)
13-14: Remove dangling foot-note markers (1,3,5,10, …) or provide the referenced foot-notesThe superscript numbers appear throughout the document but no foot-note section is defined. They distract the reader and break markdown rendering for some engines.
Either define a proper “References” section or delete the markers.
74-76: Specify the language on all fenced code blocks
markdownlint(rule MD040) flags these blocks because no language is declared. Adding the language improves syntax highlighting in IDEs and in GitHub’s rendered view.-``` # Lines 74, 94 +```dsl.openfga # OpenFGA DSL … -``` # Lines 82 +```json # JSON tuple example … -``` # Lines 104, 117, 129 +```dsl.openfgaAlso applies to: 82-84, 94-96, 104-106, 117-121, 129-131
145-145: Trim trailing space inside inline codeInline code
`define admin: [user] or repo_admin from owner `ends with a space, triggeringmarkdownlintrule MD038.-`define admin: [user] or repo_admin from owner ` +`define admin: [user] or repo_admin from owner`
224-228: Fix spelling and minor grammar in heading §6-## **6. Adding permissions -It's a common pratice to define specific permissions, that can't be directly assigned, using `can_<permission>` relations, for example: +## **6. Adding Permissions** +It’s a common practice to define specific permissions that can’t be directly assigned, using `can_<permission>` relations. For example:
254-255: Complete the truncated word “export”-* Managing OpenFGA stores, encompassing operations such as creation, listing, retrieval, deletion, import, and expor +* Managing OpenFGA stores, encompassing operations such as creation, listing, retrieval, deletion, import, and export
558-560: Consolidate duplicate testing sections (§7 and §9)There are two separate sections (“7. Testing and Validating …” and “9. Testing Models”) that cover the same topic. Merging them will avoid repetition and keep the guide succinct.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/copilot-instructions.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/copilot-instructions.md
[style] ~37-~37: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...ntity that can be related to an object. Can be a specific object, a wildcard, or a ...
(MISSING_IT_THERE)
[grammar] ~226-~226: Ensure spelling is correct
Context: ... **6. Adding permissions It's a common pratice to define specific permissions, that ca...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.17.2)
.github/copilot-instructions.md
74-74: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
82-82: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
94-94: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
104-104: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
117-117: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
129-129: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
145-145: Spaces inside code span elements
(MD038, no-space-in-code)
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Fixed minor issues and added instructions to install the CLI
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Co-authored-by: Raghd Hamzeh <raghd.hamzeh@openfga.dev>
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit