Skip to content

Commit 4ea778c

Browse files
committed
add CI part
1 parent 111066e commit 4ea778c

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

doc/development/contributing.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -669,6 +669,35 @@ catch bugs and style errors for you; :ref:`run the tests locally <run-tests>`
669669
instead before opening a new PR and before each time you push additional
670670
changes to an already-open PR.
671671

672+
Continuous integration (CI)
673+
-----------------------------------
674+
675+
MNE-Python uses `continuous integration`_ (CI) services to automatically
676+
validate pull requests. These include:
677+
678+
- `GitHub Actions`_ and `azure`_ for testing code across platforms
679+
- `CircleCI`_ for building and validating the documentation
680+
681+
If you are contributing for the first time, you may notice that `CircleCI`_
682+
jobs do not start automatically, or appear as "pending".
683+
684+
This is expected behavior. CircleCI requires **manual approval from a
685+
maintainer** before running jobs submitted by new contributors. This is a
686+
security measure to prevent misuse of CI resources.
687+
688+
As a result:
689+
690+
- CircleCI jobs may remain in a *pending* or *not running* state
691+
- This does **not** indicate a problem with your code
692+
693+
Once a maintainer approves your pull request, CircleCI will automatically run
694+
the documentation build and associated checks.
695+
696+
In the meantime:
697+
698+
- Ensure all tests pass and the docs (if relevant) are built without errors
699+
(see :ref:`run-tests` and :ref:`build-docs`)
700+
- Run style checks locally as described in :ref:`code-style`
672701

673702
Make tests fast and thorough
674703
----------------------------

0 commit comments

Comments
 (0)