Skip to content

Commit f0c816d

Browse files
zaxtaxGaelVaroquaux
authored andcommitted
Fix indentation
1 parent 684f17f commit f0c816d

File tree

1 file changed

+42
-43
lines changed

1 file changed

+42
-43
lines changed

doc/CONTRIBUTING.md renamed to CONTRIBUTING.md

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,29 @@ The preferred way to contribute to scikit-learn is to fork the
99
[main repository](http://github.com/scikit-learn/scikit-learn/) on
1010
GitHub:
1111

12-
1. Fork the [project repository](http://github.com/scikit-learn/scikit-learn):
13-
click on the 'Fork' button near the top of the page. This creates
14-
a copy of the code under your account on the GitHub server.
12+
1. Fork the [project repository](http://github.com/scikit-learn/scikit-learn):
13+
click on the 'Fork' button near the top of the page. This creates
14+
a copy of the code under your account on the GitHub server.
1515

16-
2. Clone this copy to your local disk:
16+
2. Clone this copy to your local disk:
1717

18-
$ git clone [email protected]:YourLogin/scikit-learn.git
18+
$ git clone [email protected]:YourLogin/scikit-learn.git
1919

20-
3. Create a branch to hold your changes:
20+
3. Create a branch to hold your changes:
2121

22-
$ git checkout -b my-feature
22+
$ git checkout -b my-feature
2323

24-
and start making changes. Never work in the ``master`` branch!
24+
and start making changes. Never work in the ``master`` branch!
2525

26-
4. Work on this copy, on your computer, using Git to do the version
27-
control. When you're done editing, do:
26+
4. Work on this copy, on your computer, using Git to do the version
27+
control. When you're done editing, do:
2828

29-
$ git add modified_files
30-
$ git commit
29+
$ git add modified_files
30+
$ git commit
3131

32-
to record your changes in Git, then push them to GitHub with:
32+
to record your changes in Git, then push them to GitHub with:
3333

34-
$ git push -u origin my-feature
34+
$ git push -u origin my-feature
3535

3636
Finally, go to the web page of the your fork of the scikit-learn repo,
3737
and click 'Pull request' to send your changes to the maintainers for
@@ -44,53 +44,52 @@ on the web.)
4444
It is recommended to check that your contribution complies with the
4545
following rules before submitting a pull request:
4646

47-
- All public methods should have informative docstrings with sample
48-
usage presented as doctests when appropriate.
47+
- All public methods should have informative docstrings with sample
48+
usage presented as doctests when appropriate.
4949

50-
- All other tests pass when everything is rebuilt from scratch. On
51-
Unix-like systems, check with (from the toplevel source folder):
50+
- All other tests pass when everything is rebuilt from scratch. On
51+
Unix-like systems, check with (from the toplevel source folder):
5252

53+
$ make
5354

54-
$ make
55+
- When adding additional functionality, provide at least one
56+
example script in the ``examples/`` folder. Have a look at other
57+
examples for reference. Examples should demonstrate why the new
58+
functionality is useful in practice and, if possible, compare it
59+
to other methods available in scikit-learn.
5560

56-
- When adding additional functionality, provide at least one
57-
example script in the ``examples/`` folder. Have a look at other
58-
examples for reference. Examples should demonstrate why the new
59-
functionality is useful in practice and, if possible, compare it
60-
to other methods available in scikit-learn.
61+
- At least one paragraph of narrative documentation with links to
62+
references in the literature (with PDF links when possible) and
63+
the example.
6164

62-
- At least one paragraph of narrative documentation with links to
63-
references in the literature (with PDF links when possible) and
64-
the example.
65-
66-
The documentation should also include expected time and space
67-
complexity of the algorithm and scalability, e.g. "this algorithm
68-
can scale to a large number of samples > 100000, but does not
69-
scale in dimensionality: n_features is expected to be lower than
70-
100".
65+
The documentation should also include expected time and space
66+
complexity of the algorithm and scalability, e.g. "this algorithm
67+
can scale to a large number of samples > 100000, but does not
68+
scale in dimensionality: n_features is expected to be lower than
69+
100".
7170

7271
You can also check for common programming errors with the following
7372
tools:
7473

75-
- Code with a good unittest coverage (at least 80%), check with:
74+
- Code with a good unittest coverage (at least 80%), check with:
7675

77-
$ pip install nose coverage
78-
$ nosetests --with-coverage path/to/tests_for_package
76+
$ pip install nose coverage
77+
$ nosetests --with-coverage path/to/tests_for_package
7978

80-
- No pyflakes warnings, check with:
79+
- No pyflakes warnings, check with:
8180

8281
$ pip install pyflakes
8382
$ pyflakes path/to/module.py
8483

85-
- No PEP8 warnings, check with:
84+
- No PEP8 warnings, check with:
8685

87-
$ pip install pep8
88-
$ pep8 path/to/module.py
86+
$ pip install pep8
87+
$ pep8 path/to/module.py
8988

90-
- AutoPEP8 can help you fix some of the easy redundant errors:
89+
- AutoPEP8 can help you fix some of the easy redundant errors:
9190

92-
$ pip install autopep8
93-
$ autopep8 path/to/pep8.py
91+
$ pip install autopep8
92+
$ autopep8 path/to/pep8.py
9493

9594
Bonus points for contributions that include a performance analysis with
9695
a benchmark script and profiling output (please report on the mailing

0 commit comments

Comments
 (0)