Skip to content

docs: add branch strategy section to contributing guidelines #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SyedFahad7 merged 1 commit into from
Feb 9, 2026
Merged

docs: add branch strategy section to contributing guidelines #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ We welcome ideas for improvements and new tools. There's no permission needed—

To express interest in working on an issue, simply comment on it to let us know. Maintainers will assign it to you or discuss next steps if needed.

## Branch Strategy

**Branch purposes:**
- **main**: Always reflects the latest stable and released code
- **develop**: Contains accepted changes that will be part of the next release

**For all contributors:**
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

This section says "For all contributors" PRs should target develop, but elsewhere the repo docs say only feature PRs must target develop (README "Contributing" section). Please clarify the intended rule here (all PRs vs only feature/code PRs) to avoid conflicting guidance.

Suggested change
**For all contributors:**
**For feature and code contributions:**

Copilot uses AI. Check for mistakes.
- Create a new branch from `develop`
Comment on lines +38 to +42
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

In "Branch purposes" the branch names are bolded, but immediately below they’re referenced as code (e.g., develop on line 42). Consider formatting the branch names in the purposes list as code (main, develop) as well for consistency.

Copilot uses AI. Check for mistakes.
- Open pull requests against `develop` (not `main`)

Comment on lines +41 to +44
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

The guidance to branch from develop / open PRs against develop is repeated later under "Code Contributions". Consider de-duplicating (e.g., reference this section from the later bullets) so future updates don’t drift out of sync.

Copilot uses AI. Check for mistakes.
**For regular contributors:**
If your work depends on unreleased features or changes, base your work directly on `develop`. Pull requests merged into `develop` are considered accepted for now, but remain under maintainer control. Our team decides which changes move from `develop` to `main` for release, and may revert or modify any merged code if needed.
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

The subheading "For regular contributors" doesn’t match the content of the paragraph (it describes maintainer/release-manager control over what moves from develop to main). Consider renaming this subheading (e.g., "For maintainers" / "Release process") or rewriting the paragraph so it actually contains guidance for regular contributors.

Suggested change
If your work depends on unreleased features or changes, base your work directly on `develop`. Pull requests merged into `develop` are considered accepted for now, but remain under maintainer control. Our team decides which changes move from `develop` to `main` for release, and may revert or modify any merged code if needed.
If your work depends on unreleased features or changes, base your work directly on `develop`. Keep in mind that `develop` is a staging branch: features there may change before they are released to `main`, so treat them as experimental and be prepared to update your work if behavior changes.

Copilot uses AI. Check for mistakes.

## Code Contributions

Please ensure your pull request adheres to the following guidelines:
Expand Down