mne-tools / mne-tools/mne-python
ENH: IDE configuration docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
for future code sprints / general friendliness to new contributors, it might be nice to have a website page that steps through the various IDE settings that are helpful when contributing to MNE-Python. Examples:
- how to add automatic style checking to the IDE
- how to add a ruler at 79 characters to the editor
It might also include other "tips and tricks" like how to properly link a PR to an issue that it fixes, by using GitHub's magic phrases (e.g., explain that closes #XXXX will work, but solves issue #XXXX will not)
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
No file, test, or documentation entry point is named. Start by locating the contributor-facing website documentation and checking how similar pages are organized. Done means a page covers IDE style checking, the 79-character ruler, and valid GitHub issue-linking phrases, with its scope agreed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100