mne-tools / mne-tools/mne-python
Add guide to example/tutorial writing in contributor docs
Open
Nobody has claimed this yet.
DOC
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
should cover things like section titles, code blocks, bib references, API cross-refs, etc.
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 contributor documentation and existing example or tutorial guidance in the repository. Review how section titles, code blocks, bibliographic references, and API cross-references are currently handled; the work is done when the contributor guide explains these conventions clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100