From d36595cb92be0e18bb899f809f1421789ee8b147 Mon Sep 17 00:00:00 2001
From: Christian Barra <barrachri@gmail.com>
Date: Fri, 10 Nov 2017 09:40:19 +0100
Subject: [PATCH] Add docs for contributors. (#1191)

* WIP: add docs for contributors.

* Remove changelog part.

* Simplify issue template.

* Simplify pull request template

* Simplify contributing doc.
---
 .github/ISSUE_TEMPLATE.md        | 24 ++++++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md | 13 +++++++++++++
 CONTRIBUTING.rst                 | 21 +++++++++++++++++++++
 3 files changed, 58 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 CONTRIBUTING.rst

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000000000..f1e62a1f5b1d6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,24 @@
+<!--
+General questions should be asked on the mailing list ray-dev@googlegroups.com.
+
+Before submitting an issue, please fill out the following form.
+-->
+
+### System information
+- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
+- **Ray installed from (source or binary)**:
+- **Ray version**:
+- **Python version**:
+- **Exact command to reproduce**:
+
+<!--
+You can obtain the Ray version with
+
+python -c "import ray; print(ray.__version__)"
+-->
+
+### Describe the problem
+<!-- Describe the problem clearly here. -->
+
+### Source code / logs
+<!-- Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached. Try to provide a reproducible test case that is the bare minimum necessary to generate the problem. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000000000..3c435518af6e7
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+<!--
+Thank you for your contribution!
+
+Please review https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before opening a pull request.
+-->
+
+## What do these changes do?
+
+<!-- Please give a short brief about these changes. -->
+
+## Related issue number
+
+<!-- Are there any issues opened that will be resolved by merging this change? -->
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000000000..d3f2e65230dec
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,21 @@
+Contributing to Ray
+===================
+
+Reporting bugs and asking questions
+-----------------------------------
+
+We use `GitHub issues`_ for bug reports and feature requests. For discussions
+about development, questions about usage, or any general questions, we use our
+mailing list `ray-dev@googlegroups.com`_.
+
+To contribute a patch:
+----------------------
+
+1. Break your work into small, single-purpose patches if possible. It’s much
+   harder to merge in a large change with a lot of disjoint features.
+2. Submit the patch as a GitHub pull request against the master branch.
+3. Make sure that your code passes the unit tests.
+4. Add new unit tests for your code.
+
+.. _`GitHub issues`: https://github.com/ray-project/ray/issues
+.. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev