litestar-org / litestar-org/project-template
docs: add CONTRIBUTING guide
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
## Context
The repo has no `CONTRIBUTING` file. Contributors need setup, workflow, and convention guidance. PR #16 introduced a `CONTRIBUTING.rst` we can adapt.
## Proposed tasks
- [ ] Add `CONTRIBUTING` file covering: uv setup, running tests, pre-commit, conventional commits/branches/PR titles, docs build
- [ ] Link it from `README.md` and the issue/PR templates
- [ ] Reference the org-wide [Code of Conduct](https://github.com/litestar-org/.github/blob/main/CODE_OF_CONDUCT.md)
> Open question: `.md` vs `.rst`. The rest of the docs are Sphinx/`.rst`, but `.md` renders natively on GitHub.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading PR #16, README.md, the existing Sphinx documentation, and the issue/PR templates. Use the repository’s current contributor workflow as the baseline, then ensure the guide covers uv setup, tests, pre-commit, naming conventions, pull requests, and docs builds. Done means the guide is linked from the requested locations and references the organization Code of Conduct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100