Skip to content

Commit affb6af

Browse files
committed
add contributing information to the docs
so there's a link to github
1 parent c640d5e commit affb6af

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

docs/contributing.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Contributing
2+
============
3+
4+
The project is hosted on GitHub:
5+
6+
https://github.com/derek73/python-nameparser
7+
8+
Find more information about running tests and contributing the project at the projects contribution guide.
9+
10+
https://github.com/derek73/python-nameparser/blob/master/CONTRIBUTING.md
11+
12+
Providing Example Data
13+
----------------------
14+
15+
We humans are the learning machine behind this code, and we can't do it without real world data. If it doesn't work, start a new issue because we probably don't know.
16+
17+
If you have a dataset that has lots of issues, add the data to a [gist](https://gist.github.com) and [create a new issue](https://github.com/derek73/python-nameparser/issues) so we can try to get it working as expected.
18+
19+
Feel free to update this documentation to address any questions that I missed. GitHub makes it pretty easy to edit it right on the web site now.
20+

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ HumanName prefers to handle the most common cases correctly. For example,
5555
modules
5656
resources
5757
release_log
58+
contributing
5859

5960

6061

0 commit comments

Comments
 (0)