Skip to content

Commit 3a765f9

Browse files
author
Chad Curtis
committed
Added in info on adding new features to CONTRIBUTING.md
1 parent facac3f commit 3a765f9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ wanted" is open to whoever wants to implement it.
3333
Look through the GitHub issues for features. Anything tagged with "enhancement"
3434
and "help wanted" is open to whoever wants to implement it.
3535

36+
When submitting a new feature, please use a Pull Request with a title and description
37+
of the proposed use case. Ideally, new features will include
38+
39+
- Docstrings implemented with the [Numpy format](https://www.numpy.org/devdocs/docs/howto_document.html)
40+
- Unit tests (see examples [here](https://github.com/ccurtis7/diff_classifier/tree/master/diff_classifier/tests))
41+
3642
### Write Documentation
3743

3844
Diff_classifier could always use more documentation, whether as part of the
@@ -41,9 +47,13 @@ articles, and such.
4147

4248
### Submit Feedback
4349

50+
We appreciate any and all feedback in your own implementations of diff_classifier :)
51+
4452
The best way to send feedback is to file an issue at
4553
https://github.com/ccurtis7/diff_classifier/issues.
4654

55+
56+
4757
If you are proposing a feature:
4858

4959
- Explain in detail how it would work.

0 commit comments

Comments
 (0)