Merge pull request #37 from project-codeguard/docs/faq-context-window

docs: Update CONTRIBUTING.md and FAQ

Author: santosomar

CONTRIBUTING.md

@@ -116,15 +116,10 @@ Maintainers aim to review pull requests and issues within 3 business days.
 - `main` – main development branch and authoritative source; updated after community approval for content changes
 - `develop` – staging area for community review of content updates; feature branches for content changes target this branch
 - `feature` – feature/this-is-a-new-feature-branch (target `develop` for content updates, `main` for non-content changes)
-- `codebugfix` – codebugfix/name-of-the-bug (typically targets `main`)
-- `languagefix` – languagefix/fix-details (typically targets `main`)
-- `release` – release/1.0.0 – cut from `main` when ready
-
-### Rebasing note
-
-**For content updates**: After completing work on a feature branch, rebase on `develop` before opening a PR. After PR approval, rebase again to ensure the latest `develop` changes are included before merging.
-
-**For non-content changes**: After completing work on a feature branch, rebase on `main` before opening a PR. After PR approval, rebase again to ensure the latest `main` changes are included before merging.
+- `codebugfix` – codebugfix/description-of-the-bug (typically targets `main`)
+- `languagefix` – languagefix/description-of-the-language-fix (typically targets `main`)
+- `docs` – docs/description-of-the-documentation-change (typically targets `main`; documentation changes are exempt from the content update rule above)
+- `release` – release/description-of-the-release – cut from `main` when ready
 
 ### Commit messages format
 

docs/faq.md

@@ -23,6 +23,22 @@ This FAQ document provides clear, concise answers to help developers seamlessly
    - **GitHub Copilot**: Copy `.github/instructions/` directory to your project root
 3. Restart your IDE and start coding - the AI assistant will automatically follow the security rules
 
+---
+## Q: Will these rules consume a lot of the AI agent's **context window**?
+
+**A:** No. The always-on rules are designed to be lightweight and efficient, and should not consume a lot of the AI agent's context window. The "glob" rules are designed to be applied only to the related file types specified in the rule.
+
+---
+## Q: What is the `additional_rules` folder?
+
+**A:** The `additional_rules` folder contains rules that can be used to supplement the Project CodeGuard core rules. These rules are not always-on and are not included in the downloaded release. They are only available in the `project-codeguard/rules` repository for code review and security assessments post-code generation.
+
+---
+
+## Q: How can I use the rules in my own AI agent?
+
+**A:** You can use the rules in your own AI agent by creating a custom ruleset. You can create a custom ruleset by creating a new file in the `.cursor/rules`, `.windsurf/rules`, or `.github/instructions` directories and adding the rules you want to apply. You can also use the `project-codeguard/rules` repository as a template to create your own ruleset.
+
 ---
 
 ## Q: Why does the downloaded release folder appear empty?