docs: add CONTRIBUTING guide - #32
Open
hasansezertasan wants to merge 2 commits into
Open
Conversation
Add a uv- and Makefile-based CONTRIBUTING.rst covering environment setup, contribution workflow, code guidelines, testing, and docs. Adapted from #16, converted from PDM to uv, cleaned up RST, and dropped the release section (no tools/prepare_release.py in this repo). Linked from the README. Closes #23
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a root CONTRIBUTING.rst contributor guide and links it from the README’s local development section, aligning contributor workflow and tooling docs with the project’s current uv + Makefile setup and Sphinx documentation format. Flow diagram for contributor documentation navigationflowchart TD
README[README.md Local_development_section]
CONTRIBUTING[CONTRIBUTING.rst Contributor_guide]
Sphinx[Sphinx_docs]
README --> CONTRIBUTING
CONTRIBUTING --> Sphinx
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Description
Adds a root
CONTRIBUTING.rst— a contributor onboarding guide covering environment setup, the contribution workflow, code guidelines, testing, and documentation. Linked from the README's Local development section.Adapted from #16 with these changes to match this repo's current state:
uvand the existing uv-basedMakefiletargets (make install,make lint,make test,make coverage,make docs-serve, …)..jinjahad broken/over-indented directives from copier rendering; this is hand-written, valid RST.tools/prepare_release.py, which does not exist in this repo (it was introduced in Litestarification #16). Release steps already live in the README.{{ project_name }},{{ module_name }}) →project-template/project_template.The file is
.rstto stay consistent with the Sphinx docs — andmake docs-servealready watchesCONTRIBUTING.rst.Validated with
sphinx-lint→ No problems found.Closes
Summary by Sourcery
Add a root-level CONTRIBUTING guide and reference it from the README to support contributor onboarding.
Documentation: