diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f301eab78..526629eacb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,57 +1,36 @@ # Contributing -You don't need to be a developer or a technical writer to make a significant -impact on the TensorFlow documentation—just a [GitHub account](https://github.com/). -This guide shows how to make contributions to [tensorflow.org](https://www.tensorflow.org). +Anyone with a [GitHub account](https://github.com/) and a signed Contributor License Agreement (CLA) can contribute to [tensorflow.org](https://www.tensorflow.org). -See the -[TensorFlow docs contributor guide](https://www.tensorflow.org/community/contribute/docs) -for guidance. For questions, check out [TensorFlow Forum](https://discuss.tensorflow.org/). - -Questions about TensorFlow usage are better addressed on -[Stack Overflow](https://stackoverflow.com/questions/tagged/tensorflow) or the -[discuss@tensorflow.org](https://groups.google.com/a/tensorflow.org/forum/#!forum/discuss) -mailing list. - -To contribute to the TensorFlow code repositories, see the -[TensorFlow code contributor guide](https://www.tensorflow.org/community/contribute/code) -and the -[TensorFlow contribution guidelines](https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md). - -## Contributor License Agreements - -We love patches! To publish your changes, you must sign either the individual or -corporate Contributor License Agreement (CLA): - -* If you are an individual writing original documentation or source code and - you're sure you own the intellectual property, sign an - [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html). -* If you work for a company that wants to allow you to contribute your work, sign - a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html). - -We can accept your pull requests after you sign the CLA. We can only receive -original documentation and source code from you and other people that have -signed the CLA. +We love patches but only accept your pull requests after you sign one of the CLAs below: +| CLA | Description | +| ---- | ---- | +| [Individual CLA](http://code.google.com/legal/individual-cla-v1.0.html) | You are an individual contributor who owns the intellectual property. | +| [Corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html) | Your company wants you to contribute. | # About our docs -The TensorFlow documentation is written in [Markdown](https://commonmark.org/help/) -and [Jupyter/Colab notebooks](https://colab.research.google.com/notebooks/welcome.ipynb). +The TensorFlow documentation uses [Markdown](https://commonmark.org/help/) +and [Jupyter/Colab notebooks](https://colab.research.google.com/notebooks/welcome.ipynb). The root of [tensorflow.org/](https://www.tensorflow.org/) is in the +`site/en` directory. -The root of [tensorflow.org/](https://www.tensorflow.org/) is found in the -`site/en` directory. +Not all content on tensorflow.org is in `site/en`. Some +project repositories with project-specific documentation are in +[github.com/tensorflow](https://github.com/tensorflow) and link from `site/en` to where to update the docs. -Not all technical content on tensorflow.org is located in `site/en`. Some -projects have their repositories under -[github.com/tensorflow](https://github.com/tensorflow) and they contain -project-specific documentation. These projects are navigable from the -tensorflow/docs `site/en` directory and include a redirect link to where the -docs can be updated. +Also, some content, images, and design elements are not in the `tensorflow/docs` repository. -The API reference is generated from the source code located in the core -[tensorflow/tensorflow](https://github.com/tensorflow/tensorflow) repository +The API reference is generated from the core +[tensorflow/tensorflow](https://github.com/tensorflow/tensorflow) repository source code and other projects. -Additionally, some non-technical content, images, and design elements are not -located in the `tensorflow/docs` repository. +# Getting help + +Find help based on the topic: + +| Topic | Location | +| ---- | ---- | +| Docs contribution | [TensorFlow docs contributor guide](https://www.tensorflow.org/community/contribute/docs) or [TensorFlow Forum](https://discuss.tensorflow.org/) | +| Code contribution | [TensorFlow code contributor guide](https://www.tensorflow.org/community/contribute/code) and [TensorFlow contribution guidelines](https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md) | +| TensorFlow usage | [Stack Overflow](https://stackoverflow.com/questions/tagged/tensorflow) or [discuss@tensorflow.org mailing list](https://groups.google.com/a/tensorflow.org/forum/#!forum/discuss) |