Skip to content

Commit a694ab5

Browse files
authored
Linked contribution information in README
For potential contributors who are new to GitHub and prefer to learn via structured processes, linking the Contributor's Guide and development philosophy documents in the README will make it easier for them to find this information. This will increase the quality of their contributions and make them more comfortable contributing to the project.
1 parent e52932c commit a694ab5

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,17 +89,18 @@ Fantastic documentation is available at
8989
How to Contribute
9090
-----------------
9191

92-
1. Check for open issues or open a fresh issue to start a discussion
92+
1. Become more familiar with the project by reading our [Contributor's Guide](http://docs.python-requests.org/en/latest/dev/contributing/) and our [development philosophy](http://docs.python-requests.org/en/latest/dev/philosophy/).
93+
2. Check for open issues or open a fresh issue to start a discussion
9394
around a feature idea or a bug. There is a [Contributor
9495
Friendly](https://github.com/requests/requests/issues?direction=desc&labels=Contributor+Friendly&page=1&sort=updated&state=open)
9596
tag for issues that should be ideal for people who are not very
9697
familiar with the codebase yet.
97-
2. Fork [the repository](https://github.com/requests/requests) on
98+
3. Fork [the repository](https://github.com/requests/requests) on
9899
GitHub to start making your changes to the **master** branch (or
99100
branch off of it).
100-
3. Write a test which shows that the bug was fixed or that the feature
101+
4. Write a test which shows that the bug was fixed or that the feature
101102
works as expected.
102-
4. Send a pull request and bug the maintainer until it gets merged and
103+
5. Send a pull request and bug the maintainer until it gets merged and
103104
published. :) Make sure to add yourself to
104105
[AUTHORS](https://github.com/requests/requests/blob/master/AUTHORS.rst).
105106

0 commit comments

Comments
 (0)