Set up CI to run code examples
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The examples in tips themselves might be excerpts for brevity purposes, but there should be a complete, runnable example that is heavily commented that people can run.
We want to make sure these examples continue to work, and catch that in CI where possible (rather than readers complaining).
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 inventorying the examples referenced in the tips and checking the repository's existing CI configuration. Identify which examples can run in CI and what complete, heavily commented versions are needed; done means the selected examples execute successfully through CI and future breakage is detected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100