Skip to content

Commit 05f9d21

Browse files
committed
Update CONTRIBUTING.md and include it in future releases.
1 parent 9634b5a commit 05f9d21

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ You can also use Github issues to request features you would like to see in Kera
4848
1. **Keras improvements and bugfixes** go to the [Keras `master` branch](https://github.com/fchollet/keras/tree/master).
4949
2. **Experimental new features** such as layers and datasets go to [keras-contrib](https://github.com/farizrahman4u/keras-contrib). Unless it is a new feature listed in [Requests for Contributions](https://github.com/fchollet/keras/projects/1), in which case it belongs in core Keras. If you think your feature belongs in core Keras, you can submit a design doc to explain your feature and argue for it (see explanations below).
5050

51+
Please note that PRs that are primarily about **code style** (as opposed to fixing bugs, improving docs, or adding new functionality) will likely be rejected.
52+
5153
Here's a quick guide to submitting your improvements:
5254

5355
1. If your PR introduces a change in functionality, make sure you start by writing a design doc and sending it to the Keras mailing list to discuss whether the change should be made, and how to handle it. This will save you from having your PR closed down the road! Of course, if your PR is a simple bug fix, you don't need to do that. The process for writing and submitting design docs is as follow:
@@ -82,7 +84,7 @@ Here's a quick guide to submitting your improvements:
8284

8385
9. Update the documentation. If introducing new functionality, make sure you include code snippets demonstrating the usage of your new feature.
8486

85-
10. Submit your PR. If your changes have been approved in a previous discussion, and if you have complete (and passing) unit tests as well as proper docstrings/documentation, your PR is likely to be merged promptly. Otherwise, well...
87+
10. Submit your PR. If your changes have been approved in a previous discussion, and if you have complete (and passing) unit tests as well as proper docstrings/documentation, your PR is likely to be merged promptly.
8688

8789
---
8890

MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
include LICENSE
22
include README.md
3+
include CONTRIBUTING.md
34
graft docs
45
graft examples
56
graft tests

0 commit comments

Comments
 (0)