Merge pull request #31472 from rallytime/update-contributing-docs

Update contributing docs

Contributing.rst

@@ -13,9 +13,10 @@ Please read the following guidelines before you `report an issue`_
 1. **Use the GitHub issue search** — check if the issue has
    already been reported. If it has been, please comment on the existing issue.
 
-2. **Check if the issue has been fixed** — the latest `develop`
-   branch may already contain a fix. Please try to reproduce the bug against
-   the latest git head or the latest release.
+2. **Check if the issue has been fixed** — Various point-release branches, such
+   as ``2015.5``, ``2015.8``, ``2016.3``, or even ``develop``, may already contain
+   a fix. Please try to reproduce the bug against the latest git HEAD or the latest
+   release.
 
 3. **Isolate the demonstrable problem** — make sure that the
    code in the project's repository is *definitely* responsible for the issue.
@@ -23,7 +24,7 @@ Please read the following guidelines before you `report an issue`_
 4. **Include a reproducible example** — Provide the steps which
    led you to the problem.
 
-Please try to be as detailed as possible in your report too. What is your
+Please try to be as detailed as possible in your report, too. What is your
 environment? What steps will reproduce the issue? What Operating System? What
 would you expect to be the outcome? All these details will help people to
 assess and fix any potential bugs.
@@ -38,16 +39,16 @@ Features
 
 Salt is always working to be more powerful. Feature additions and requests are
 welcomed. When requesting a feature it will be categorized for a release or
-placed under "Approved for Future Release".
+placed under the "Feature" label.
 
 If a new feature is desired, the fastest way to get it into Salt is to
-contribute the code. Before starting on a new feature an issue should be filed
+contribute the code. Before starting on a new feature, an issue should be filed
 for it. The one requesting the feature will be able to then discuss the feature
 with the Salt team and discover the best way to get the feature into Salt and
 if the feature makes sense.
 
-It is extremely common that the desired feature has already been completed,
-look for it in the docs, ask about it first in IRC, and on the mailing list
+It is extremely common that the desired feature has already been completed.
+Look for it in the docs, ask about it first in IRC, and on the mailing list
 before filing the request. It is also common that the problem which would be
 solved by the new feature can be easily solved another way, which is a great
 reason to ask first.
@@ -55,9 +56,13 @@ reason to ask first.
 Fixing issues
 =============
 
-If you wish to help us fixing the issue you're reporting, `Salt's documentation`_ already includes
+If you wish to help us fix the issue you're reporting, `Salt's documentation`_ already includes
 information to help you setup a development environment, under `Developing Salt`_.
 
+`SaltStack's Contributing documentation`_ is also helpful, as it explains sending in pull requests,
+keeping your salt branches in sync, and knowing `which branch`_ new features or bug fixes should be
+submitted against.
+
 Fix the issue you have in hands, if possible also add a test case to Salt's testing suite, create a
 `pull request`_, and **that's it**!
 
@@ -69,5 +74,7 @@ salt's code.
 .. _`Salt's documentation`: http://docs.saltstack.com/en/latest/index.html
 .. _`Developing Salt`: http://docs.saltstack.com/en/latest/topics/development/hacking.html
 .. _`pull request`: http://docs.saltstack.com/en/latest/topics/development/contributing.html#sending-a-github-pull-request
+.. _`SaltStack's Contributing documentation`: https://docs.saltstack.com/en/latest/topics/development/contributing.html
+.. _`which branch`: https://docs.saltstack.com/en/latest/topics/development/contributing.html#which-salt-branch
 
 .. vim: fenc=utf-8 spell spl=en