[DOC] Contributor checklist
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
We could use a concrete checklist to list out the things that contributors (both NVIDIA and externally) should include in their PRs in addition to the fixes and capabilities. Things like "Add/update relevant doxygen updates and code examples for all API changes", "Update the developer guide", "Update docs", "If changes break C ABI, follow the stability guidelines", "Make sure all perf critical pieces are benchmarked and benchmarks published to the PR".
I think this will be a good exercise for both reviewers and contributors, to make sure the expectations are concrete and aligned. Marking a placeholder issue for us to identify these things.
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
The issue names no file, test, or entry point. Start by identifying the project’s contributor and developer-guide documentation, then organize the stated expectations around API documentation and examples, guide and docs updates, C ABI stability, and performance benchmarks; done means a concrete checklist that aligns contributor and reviewer expectations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100