saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update branch refs to more relevant branch (#37826)

Browse source 
And cleanup some :ref: links that are rendering incorrectly
This commit is contained in:
Nicole Thomas 2016-11-21 16:41:02 -07:00 • committed by GitHub
parent 6a9b49c782
commit 0e74bad284
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/topics/development/contributing.rst
View file

@ -18,13 +18,13 @@ Salt Coding Style
-----------------
SaltStack has its own coding style guide that informs contributors on various coding
approaches. Please review the :ref:`Salt Coding Style<coding-style>`_ documentation
approaches. Please review the :ref:`Salt Coding Style<coding-style>` documentation
for information about Salt's particular coding patterns.
Within the :ref:`Salt Coding Style<coding-style>`_ documentation, there is a section
Within the :ref:`Salt Coding Style<coding-style>` documentation, there is a section
about running Salt's ``.pylintrc`` file. SaltStack recommends running the ``.pylintrc``
file on any files you are changing with your code contribution before submitting a
pull request to Salt's repository. Please see the :ref:`Linting<pylint-instructions>`_
pull request to Salt's repository. Please see the :ref:`Linting<pylint-instructions>`
documentation for more information.
@ -66,7 +66,7 @@ Fork a Repo Guide_>`_ and is well worth reading.
.. code-block:: bash
git fetch upstream
git checkout -b fix-broken-thing upstream/2015.5
git checkout -b fix-broken-thing upstream/2016.3
If you're working on a feature, create your branch from the develop branch.
@ -95,9 +95,9 @@ Fork a Repo Guide_>`_ and is well worth reading.
.. code-block:: bash
fix broken things in file1 and file2
Fix broken things in file1 and file2
Fixes #31337. The issue is now eradicated from file1 and file2.
Fixes #31337
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
@ -130,7 +130,7 @@ Fork a Repo Guide_>`_ and is well worth reading.
.. code-block:: bash
git fetch upstream
git rebase upstream/2015.5 fix-broken-thing
git rebase upstream/2016.3 fix-broken-thing
git push -u origin fix-broken-thing
or
@ -170,9 +170,9 @@ Fork a Repo Guide_>`_ and is well worth reading.
https://github.com/my-account/salt/pull/new/fix-broken-thing
#. If your branch is a fix for a release branch, choose that as the base
branch (e.g. ``2015.5``),
branch (e.g. ``2016.3``),
https://github.com/my-account/salt/compare/saltstack:2015.5...fix-broken-thing
https://github.com/my-account/salt/compare/saltstack:2016.3...fix-broken-thing
If your branch is a feature, choose ``develop`` as the base branch,
@ -225,7 +225,7 @@ The current release branch
The current release branch is the most recent stable release. Pull requests
containing bug fixes should be made against the release branch.
The branch name will be a date-based name such as ``2015.5``.
The branch name will be a date-based name such as ``2016.3``.
Bug fixes are made on this branch so that minor releases can be cut from this
branch without introducing surprises and new features. This approach maximizes
@ -392,7 +392,7 @@ And ``upstream`` is the name of the remote pointing to the main Salt repo.
git rebase --onto <release-branch> <orig-base> bp-1234
Note, release branches prior to ``2015.5`` will not be able to make use of
Note, release branches prior to ``2016.3`` will not be able to make use of
rebase and must use cherry-picking instead.
5. Push the back-port branch to GitHub and open a new pull request.