8000 Merge pull request #6462 from scottclowe/doc-align-contrubting-code-i… · rhiever/scikit-learn@0de2cb5 · GitHub
[go: up one dir, main page]

Skip to content

Commit 0de2cb5

Browse files
committed
Merge pull request scikit-learn#6462 from scottclowe/doc-align-contrubting-code-indents
DOC: Align the code blocks in CONTRIBUTING.md with tab
2 parents bba6826 + f300632 commit 0de2cb5

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,24 @@ GitHub:
2121

2222
2. Clone this copy to your local disk:
2323

24-
$ git clone git@github.com:YourLogin/scikit-learn.git
25-
$ cd scikit-learn
24+
$ git clone git@github.com:YourLogin/scikit-learn.git
25+
$ cd scikit-learn
2626

2727
3. Create a branch to hold your changes:
2828

29-
$ git checkout -b my-feature
29+
$ git checkout -b my-feature
3030

3131
and start making changes. Never work in the ``master`` branch!
3232

3333
4. Work on this copy on your computer using Git to do the version
3434
control. When you're done editing, do:
3535

36-
$ git add modified_files
37-
$ git commit
36+
$ git add modified_files
37+
$ git commit
3838

3939
to record your changes in Git, then push them to GitHub with:
4040

41-
$ git push -u origin my-feature
41+
$ git push -u origin my-feature
4242

4343
Finally, go to the web page of your fork of the scikit-learn repo,
4444
and click 'Pull request' to send your changes to the maintainers for
@@ -56,7 +56,7 @@ following rules before submitting a pull request:
5656
- All other tests pass when everything is rebuilt from scratch. On
5757
Unix-like systems, check with (from the toplevel source folder):
5858

59-
$ make
59+
$ make
6060

6161
- When adding additional functionality, provide at least one
6262
example script in the ``examples/`` folder. Have a look at other
@@ -79,23 +79,23 @@ tools:
7979

8080
- Code with good unittest coverage (at D36A least 80%), check with:
8181

82-
$ pip install nose coverage
83-
$ nosetests --with-coverage path/to/tests_for_package
82+
$ pip install nose coverage
83+
$ nosetests --with-coverage path/to/tests_for_package
8484

8585
- No pyflakes warnings, check with:
8686

87-
$ pip install pyflakes
88-
$ pyflakes path/to/module.py
87+
$ pip install pyflakes
88+
$ pyflakes path/to/module.py
8989

9090
- No PEP8 warnings, check with:
9191

92-
$ pip install pep8
93-
$ pep8 path/to/module.py
92+
$ pip install pep8
93+
$ pep8 path/to/module.py
9494

9595
- AutoPEP8 can help you fix some of the easy redundant errors:
9696

97-
$ pip install autopep8
98-
$ autopep8 path/to/pep8.py
97+
$ pip install autopep8
98+
$ autopep8 path/to/pep8.py
9999

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

0 commit comments

Comments
 (0)
0