8000 DOC add CI details and commands to contributor guide (#8024) · scikit-learn/scikit-learn@9ec1a4c · GitHub
[go: up one dir, main page]

Skip to content

Commit 9ec1a4c

Browse files
alexandercboothjnothman
authored andcommitted
DOC add CI details and commands to contributor guide (#8024)
1 parent 84f260a commit 9ec1a4c

File tree

2 files changed

+31
-13
lines changed

2 files changed

+31
-13
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original f 10000 ile line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ likelihood of your contribution being merged.**
1212
How to contribute
1313
-----------------
1414

15-
The preferred workflow for contributing to scikit-learn is to fork the
15+
The preferred workflow for contributing to scikit-learn is to fork the
1616
[main repository](https://github.com/scikit-learn/scikit-learn) on
1717
GitHub, clone, and develop on a branch. Steps:
1818

@@ -26,13 +26,13 @@ GitHub, clone, and develop on a branch. Steps:
2626
$ git clone git@github.com:YourLogin/scikit-learn.git
2727
$ cd scikit-learn
2828
```
29-
29+
3030
3. Create a ``feature`` branch to hold your development changes:
3131

3232
```bash
3333
$ git checkout -b my-feature
3434
```
35-
35+
3636
Always use a ``feature`` branch. It's good practice to never work on the ``master`` branch!
3737

3838
4. Develop the feature on your feature branch. Add changed files using ``git add`` and then ``git commit`` files:
@@ -52,7 +52,7 @@ GitHub, clone, and develop on a branch. Steps:
5252
Click the 'Pull request' button to send your changes to the project's maintainers for
5353
review. This will send an email to the committers.
5454

55-
(If any of the above seems like magic to you, please look up the
55+
(If any of the above seems like magic to you, please look up the
5656
[Git documentation](https://git-scm.com/documentation) on the web, or ask a friend or another contributor for help.)
5757

5858
Pull Request Checklist
@@ -179,7 +179,7 @@ following rules before submitting:
179179
import scipy; print("SciPy", scipy.__version__)
180180
import sklearn; print("Scikit-Learn", sklearn.__version__)
181181
```
182-
182+
183183
- Please be specific about what estimators and/or functions are involved
184184
and the shape of the data, as appropriate; please include a
185185
[reproducible](http://stackoverflow.com/help/mcve) code snippet
@@ -228,5 +228,5 @@ Further Information
228228
-------------------
229229

230230
Visit the [Contributing Code](http://scikit-learn.org/stable/developers/index.html#coding-guidelines)
231-
section of the website for more information including conforming to the
231+
section of the website for more information including conforming to the
232232
API spec and profiling contributed code.

doc/developers/contributing.rst

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,24 @@ and Cython optimizations.
263263
<http://astropy.readthedocs.io/en/latest/development/workflow/development_workflow.html>`_
264264
sections.
265265

266+
.. topic:: Continuous Integration (CI)
267+
268+
* Travis is used for testing on Linux platforms
269+
* Appveyor is used for testing on Windows platforms
270+
* CircleCI is used to build the docs for viewing
271+
272+
Please note that if one of the following markers appear in the latest commit
273+
message, the following actions are taken.
274+
275+
====================== ===================
276+
Commit Message Marker Action Taken by CI
277+
---------------------- -------------------
278+
[ci skip] CI is skipped completely
279+
[doc skip] Docs are not built
280+
[doc quick] Docs built, but excludes example gallery plots
281+
[doc build] Docs built including example gallery plots
282+
====================== ===================
283+
266284
.. _filing_bugs:
267285

268286
Filing Bugs
@@ -309,10 +327,10 @@ following rules before submitting:
309327
Issues for New Contributors
310328
---------------------------
311329

312-
New contributors should look for the following tags when looking for issues.
313-
We strongly recommend that new contributors tackle "easy" issues first: this
314-
helps the contributor become familiar with the contribution workflow, and
315-
for the core devs to become acquainted with the contributor; besides which,
330+
New contributors should look for the following tags when looking for issues.
331+
We strongly recommend that new contributors tackle "easy" issues first: this
332+
helps the contributor become familiar with the contribution workflow, and
333+
for the core devs to become acquainted with the contributor; besides which,
316334
we frequently underestimate how easy an issue is to solve!
317335

318336
.. topic:: Easy Tags
@@ -327,7 +345,7 @@ we frequently underestimate how easy an issue is to solve!
327345

328346
.. topic:: Need Contributor Tags
329347

330-
We often use the Need Contributor tag to mark issues regardless of difficulty. Additionally,
348+
We often use the Need Contributor tag to mark issues regardless of difficulty. Additionally,
331349
we use the Need Contributor tag to mark Pull Requests which have been abandoned
332350
by their original contributor and are available for someone to pick up where the original
333351
contributor left off. The list of issues with the Need Contributor tag can be found
@@ -488,8 +506,8 @@ There are three other tags to help new contributors:
488506
but is still approachable for someone new to the project.
489507

490508
:Needs Contributor:
491-
This tag marks an issue which currently lacks a contributor or a
492-
PR that needs another contributor to take over the work. These
509+
This tag marks an issue which currently lacks a contributor or a
510+
PR that needs another contributor to take over the work. These
493511
issues can range in difficulty, and may not be approachable
494512
for new contributors. Note that not all issues which need
495513
contributors will have this tag.

0 commit comments

Comments
 (0)
0