pymc-devs / pymc-devs/pymc-examples
improve pre-commit checks when example notebooks are removed
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 398
- Forks
- 325
- Avg merge
- 9d 15m
- Merged PRs (30d)
- 1
Description
When removing an example .ipynb file, the pre-commit checks do not check that the corresponding myst.md file has been deleted. Could add a check that there are no myst.md files without corresponding .ipynb files.
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 locating the repository's pre-commit checks and how example .ipynb and myst.md files are organized. Add coverage for orphaned myst.md files, then run the existing pre-commit checks to confirm that a myst.md file without a corresponding .ipynb file is detected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100