diff options
| author | leeyspaul <t.leeyspaul@gmail.com> | 2020-07-13 20:15:37 -0700 |
|---|---|---|
| committer | leeyspaul <t.leeyspaul@gmail.com> | 2020-07-13 20:15:37 -0700 |
| commit | e7196cc3979cdee7b5ce0ca69624822b6c17afe6 (patch) | |
| tree | a49a6528654323bdf2dd2f47c57b574a740e2417 | |
| parent | a724ce89e37d00eddb20558dd383433071c07536 (diff) | |
| download | numpy-e7196cc3979cdee7b5ce0ca69624822b6c17afe6.tar.gz | |
DOC: clarify whats required for new features see #13924
| -rw-r--r-- | .github/CONTRIBUTING.md | 7 | ||||
| -rw-r--r-- | doc/source/dev/index.rst | 1 |
2 files changed, 8 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 22113b913..3f837a8e7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -29,3 +29,10 @@ If you are writing new C code, please follow the style described in Suggested ways to work on your development version (compile and run the tests without interfering with system packages) are described in ``doc/source/dev/development_environment.rst``. + +### A note on feature enhancements/API changes + +1. If you are looking to enhance features or make any API changes please note that NumPy +prefers not to add new APIs but instead leave these to more specialized packages. +2. If you would like to add a new feature please make sure you raise the feature in our +mailing list first to get alignment. You can sign up for the mailing list [here](https://mail.python.org/mailman/listinfo/numpy-discussion).
\ No newline at end of file diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst index aeb277a87..fc2fe32de 100644 --- a/doc/source/dev/index.rst +++ b/doc/source/dev/index.rst @@ -173,6 +173,7 @@ Guidelines * No changes are ever committed without review and approval by a core team member.Please ask politely on the PR or on the `mailing list`_ if you get no response to your pull request within a week. +* If you would like to create a new feature please get alignment first by discussing the feature in the `mailing list`_ Stylistic Guidelines -------------------- |