1
1
Contributing to pycodestyle
2
- ===============================
2
+ ===========================
3
3
4
4
When contributing to pycodestyle, please observe our `Code of Conduct `_.
5
5
6
6
Step 1: Forking pycodestyle for editing
7
7
---------------------------------------
8
8
9
- Fork the pycodestyle repository on github . This will add
10
- pycodestyle to your github account. You will push your changes to your
9
+ Fork the pycodestyle repository on GitHub . This will add
10
+ pycodestyle to your GitHub account. You will push your changes to your
11
11
fork and then make pull requests into the official pycodestyle repository.
12
12
13
- Github has an excellent `guide `_ that has screenshots on how to do this.
13
+ GitHub has an excellent `guide `_ that has screenshots on how to do this.
14
14
15
15
Next, clone your fork of the pycodestyle repository to your system for
16
16
editing::
@@ -22,7 +22,7 @@ edits. Next we will setup `virtualenv`_ which will help create an isolated
22
22
environment to manage dependancies.
23
23
24
24
25
- Step 3 : Use virtualenv when developing
25
+ Step 2 : Use virtualenv when developing
26
26
--------------------------------------
27
27
28
28
`virtualenv `_ is a tool to create isolated python environments.
@@ -48,7 +48,7 @@ To deactivate the virtualenv you can type::
48
48
For more information see `virtualenv `_'s documentation.
49
49
50
50
51
- Step 4 : Run tests
51
+ Step 3 : Run tests
52
52
-----------------
53
53
54
54
Before creating a pull request you should run the tests to make sure that the
@@ -64,7 +64,7 @@ All the tests should pass for all available interpreters, with the summary of::
64
64
65
65
At this point you can create a pull request back to the official pycodestyles
66
66
repository for review! For more information on how to make a pull request,
67
- github has an excellent `guide `_.
67
+ GitHub has an excellent `guide `_.
68
68
69
69
.. _virtualenv : http://docs.python-guide.org/en/latest/dev/virtualenvs/
70
70
.. _guide : https://guides.github.com/activities/forking/
0 commit comments