mne-tools / mne-tools/mne-python
Improving usage guidelines for running mne using wsl2
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
Proposed documentation enhancement
Hello! I exclusively contribute to mne using wsl2 and was wondering if I could add a short section to the contribution guide that contains some of the steps I follow to make sure my environment works for mne development. Thanks!
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 contribution guide and review the existing development-environment instructions. Document the WSL2 setup steps needed for MNE development, then verify that the section is accurate and fits the guide's style.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100