add CI description to contributing guide#13837
Open
CarinaFo wants to merge 4 commits intomne-tools:mainfrom
Open
add CI description to contributing guide#13837CarinaFo wants to merge 4 commits intomne-tools:mainfrom
CarinaFo wants to merge 4 commits intomne-tools:mainfrom
Conversation
CarinaFo
force-pushed
the
update_contributing
branch
from
4ea778c to
b1b8b9e
Compare
Contributor
Author
|
CI failure seems unrelated (PyVista/VTK on Python 3.13). |
larsoner
reviewed
Apr 12, 2026
drammock
reviewed
Apr 22, 2026
|
|
||
| If you are contributing for the first time, you may notice that `Github Actions`_ | ||
| jobs do not start automatically, or appear as "pending". | ||
|
|
Member
There was a problem hiding this comment.
remove blank line, make these all one paragraph
| - Github Actions jobs may remain in a *pending* or *not running* state | ||
| - This does **not** indicate a problem with your code | ||
|
|
||
| Once a maintainer approves your pull request, Github Actions workflows will run. |
| - This does **not** indicate a problem with your code | ||
|
|
||
| Once a maintainer approves your pull request, Github Actions workflows will run. | ||
| Future contributions will not require manual approval. |
Member
There was a problem hiding this comment.
Once you have at least one PR merged into the MNE-Python repository, future ...
| Once a maintainer approves your pull request, Github Actions workflows will run. | ||
| Future contributions will not require manual approval. | ||
|
|
||
| `CircleCI`_ requires to sign up for an account and link it with your github repository |
Member
There was a problem hiding this comment.
CircleCI will not build our documentation unless the GitHub account of the PR's most recent commit is associated with a CircleCI account. Creating one is easy and free, choose "login with GitHub" on to get started.
| `CircleCI`_ requires to sign up for an account and link it with your github repository | ||
| that you use to contribute to MNE-Python. | ||
|
|
||
| The tests will fail if you are not a registered user before you push your changes. |
Member
There was a problem hiding this comment.
If you do not do this, it will show up as a failing CI job.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the Contributing Guide to improve clarity and usability of the CI (Continuous Integration) section.
The current contributing guide links to a Wikipedia page on CI but does not explain why we use CI.
This update aims to make it easier for new contributors to:
Understand what CI is doing and why it is important to run checks locally before pushing changes. This is particularly relevant, as we receive many user comments about CircleCI and failing doc builds for unregistered users.