Repository navigation
Add a contributing guide to the docs - #31
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The setup command needs editable installation so contributors test their working-tree changes rather than an installed snapshot.
1 open issue
What changed in this PR
Adds a contributor guide to the Sphinx documentation, giving new contributors a central reference for getting involved and validating changes.
Changes:
- Documents contribution options, development setup, and the pull request workflow.
- Provides instructions for linting, testing, and building documentation.
- Links the guide from the documentation index and adds a citation-section anchor.
| File | Description |
|---|---|
| doc/index.rst | Adds the guide to navigation and an anchor for the licence reference. |
| doc/contributing.rst | Introduces contributor setup, workflow, and validation instructions. |
Review effort: Balanced
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
rahulsavani
approved these changes
Oct 26, 2026
rahulsavani
left a comment
rahulsavani
left a comment
Member
There was a problem hiding this comment.
Looks good to me. I just made one minor edit.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added a new
contributing.rstpage to the documentation for new contributors to learn how to get involved.It includes: