DOC, TODO: advanced dev docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- azure, git, python
- Domain
- ci-cd, developer-experience, documentation
Research direction
Start by reviewing issue #6254 and the repository's existing developer documentation; no specific file or test is identified here. Scope the requested advanced Git and development topics, then define the documentation pages and checklist items that will be considered complete.
Written by the indexing model from the issue text.
Description
I'd been hoping we could avoid it and let the rest of the internet handle advanced git advice, but based on conversations in #6254, it seems like a troubleshooting / advanced git page might be wanted (at least by some)?
- when, how, and why to rebase
- tips like
git push -u -
git commit --amendandgit push --force -
git stash -
git diff - discussion of git GUIs
Other advanced dev topics:
- PR best practices (e.g., linking to changed doc pages on Circle after they render, when to add tests / changelog entries, etc)
- overview of our CIs (memory limits, what gets tested where, etc)
- figuring out why CircleCI / Azure / Travis errorred
- reviewing PRs, making "suggestions", committing "suggestions" through the web UI...
- profiling: link to sklearn profiling page
- docstring formatting guidelines (e.g., where we deviate from the NumPyDoc style)
@jeythekey @massich @larsoner @mmagnuski
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
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.
More from mne-tools/mne-python
-
ENH
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mne-tools/mne-python#13743 · 2 comments ·
-
ENH
Difficulty 3/5 1-2 days Newbie friendliness 68/100
mne-tools/mne-python#14318 ·
-
BUG
Difficulty 3/5 1-2 days Newbie friendliness 68/100
mne-tools/mne-python#14317 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
mne-tools/mne-python#14311 · 1 comment · 1 reaction ·
-
ENH
Difficulty 5/5 Over a week Newbie friendliness 35/100
mne-tools/mne-python#14309 · 1 comment ·
All issues in mne-tools/mne-python
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100