Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jbesomi committed Jul 22, 2020
1 parent 57e14f5 commit 4ebc736
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,11 @@ Texthero is there for the NLP-community. If you have an idea on how we can impro

## Best practices

1. Read and respect the [numpydoc docstring guide](https://numpydoc.readthedocs.io/en/latest/format.html). Look at the code for similarity.
1. Give to your branch a meaningful name. Avoid using the master branch.
1. Make sure Pull Request only changes one thing and one thing only. PR should be independent and self-contained. Read this article: [A Plea For Small Pull Requests](https://opensource.zalando.com/blog/2017/10/small-pull-requests/)
1. Name your PR title accordingly to your changes and add a good and exhaustive description
1. Give to the branch a meaningful name. Avoid using the master branch.
1. Respect [numpydoc docstring guide](https://numpydoc.readthedocs.io/en/latest/format.html). Look at the code for similarity.


## Good first issue

Expand Down

0 comments on commit 4ebc736

Please sign in to comment.