diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b978f89f9e1..73782143a3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,24 +55,28 @@ TensorFlow coding style. #### General guidelines and philosophy for contribution -* Include unit tests when you contribute new features, as they help to - a) prove that your code works correctly, and b) guard against future breaking - changes to lower the maintenance cost. -* Bug fixes also generally require unit tests, because the presence of bugs - usually indicates insufficient test coverage. -* Keep API compatibility in mind when you change code in core TensorFlow, - e.g., code in [tensorflow/core](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/core) and [tensorflow/python](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/python). - TensorFlow has reached version 1 and hence cannot make - non-backward-compatible API changes without a major release. Reviewers of your - pull request will comment on any API compatibility issues. -* When you contribute a new feature to TensorFlow, the maintenance burden is (by - default) transferred to the TensorFlow team. This means that benefit of the - contribution must be compared against the cost of maintaining the feature. -* Full new features (e.g., a new op implementing a cutting-edge algorithm) - typically will live in - [tensorflow/contrib](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/contrib) - to get some airtime before decision is made regarding whether they are to be - migrated to the core. +* Include unit tests when you contribute new features, as they help to a) + prove that your code works correctly, and b) guard against future breaking + changes to lower the maintenance cost. +* Bug fixes also generally require unit tests, because the presence of bugs + usually indicates insufficient test coverage. +* Keep API compatibility in mind when you change code in core TensorFlow, + e.g., code in + [tensorflow/core](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/core) + and + [tensorflow/python](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/python). + TensorFlow has reached version 1 and hence cannot make + non-backward-compatible API changes without a major release. Reviewers of + your pull request will comment on any API compatibility issues. +* When you contribute a new feature to TensorFlow, the maintenance burden is + (by default) transferred to the TensorFlow team. This means that benefit of + the contribution must be compared against the cost of maintaining the + feature. +* Full new features (e.g., a new op implementing a cutting-edge algorithm) + typically will live in + [tensorflow/addons](https://github.com/tensorflow/addons) to get some + airtime before decision is made regarding whether they are to be migrated to + the core. #### License