Improve testing/demos guide and add benchmarks
Open
Nobody has claimed this yet.
documentation
improvement
just do it
- Dominant language
- Python
- Stars
- 14.4k
- Forks
- 1.3k
- PR merge metrics
- No merged PRs in 30d
Description
We have existing documentation for creating tests and demos in doc/code/testing.md.
- Simplify and improve the guide
- Add a how-to for benchmarks
Contributor guide
No contributing guide indexed for this repository
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 doc/code/testing.md and the benchmark context in linked pull request #802. Review the existing testing and demo guidance, then define the benchmark how-to from that context. Done means the guide is simpler and improved, with a documented benchmark workflow added.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100