Skip to content

Commit bc35548

Browse files
authored
Move skip ci instructions to contributing guide (#4829)
1 parent 93ea177 commit bc35548

File tree

2 files changed

+1
-8
lines changed

2 files changed

+1
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

-8
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,3 @@
55
- [ ] Passes `pre-commit run --all-files`
66
- [ ] User visible changes (including notable bug fixes) are documented in `whats-new.rst`
77
- [ ] New functions/methods are listed in `api.rst`
8-
9-
10-
<sub>
11-
<h3>
12-
Overriding CI behaviors
13-
</h3>
14-
By default, the upstream dev CI is disabled on pull request and push events. You can override this behavior per commit by adding a <tt>[test-upstream]</tt> tag to the first line of the commit message. For documentation-only commits, you can skip the CI per commit by adding a <tt>[skip-ci]</tt> tag to the first line of the commit message
15-
</sub>

doc/contributing.rst

+1
Original file line numberDiff line numberDiff line change
@@ -836,6 +836,7 @@ PR checklist
836836
837837
- Write new tests if needed. See `"Test-driven development/code writing" <https://xarray.pydata.org/en/stable/contributing.html#test-driven-development-code-writing>`_.
838838
- Test the code using `Pytest <http://doc.pytest.org/en/latest/>`_. Running all tests (type ``pytest`` in the root directory) takes a while, so feel free to only run the tests you think are needed based on your PR (example: ``pytest xarray/tests/test_dataarray.py``). CI will catch any failing tests.
839+
- By default, the upstream dev CI is disabled on pull request and push events. You can override this behavior per commit by adding a <tt>[test-upstream]</tt> tag to the first line of the commit message. For documentation-only commits, you can skip the CI per commit by adding a "[skip-ci]" tag to the first line of the commit message.
839840
840841
- **Properly format your code** and verify that it passes the formatting guidelines set by `Black <https://black.readthedocs.io/en/stable/>`_ and `Flake8 <http://flake8.pycqa.org/en/latest/>`_. See `"Code formatting" <https://xarray.pydata.org/en/stablcontributing.html#code-formatting>`_. You can use `pre-commit <https://pre-commit.com/>`_ to run these automatically on each commit.
841842

0 commit comments

Comments
 (0)