docs: add contributing guide and issue/PR templates - #499
Draft
lkdvos wants to merge 1 commit into
Draft
Conversation
`CONTRIBUTING.md` is the canonical guide, rendered as a page through the thin `docs/src/contributing.md` include so it is reachable from the site as well as from GitHub. Issue templates split bug reports from questions, since the two need very different information, and the PR template asks for the things review kept having to ask for. Also refreshes `README.md` with a short positioning statement, brings `CITATION.cff` up to the v0.13.13 release, and records in the docstring style guide that unverified physics claims get a REVIEW marker for the maintainer. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
lkdvos
force-pushed
the
docs/contributing
branch
from
August 3, 2026 23:16
e5339d3 to
cb61f2a
Compare
Contributor
|
After the build completes, the updated documentation will be available here |
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
1 participant
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.
Split out of #449 so it can be reviewed on its own; independent of the documentation content.
CONTRIBUTING.mdis the canonical guide, rendered as a page through the thindocs/src/contributing.mdinclude so it is reachable from the site as well as from GitHub. Issue templates split bug reports from questions, since the two need very different information, and the PR template asks for the things review kept having to ask for.Also refreshes
README.mdwith a short positioning statement, bringsCITATION.cffup to the v0.13.13 release, and records in the docstring style guide that unverified physics claims get a REVIEW marker for the maintainer.🤖 Generated with Claude Code