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

Merge pull request #55610 from cmcmarrow/branch_doc_update

Browse source 
Update Branch Topology Doc
This commit is contained in:
Daniel Wozniak 2020-01-16 09:53:06 -07:00 • committed by GitHub
commit 8708078905
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -42,6 +42,7 @@ get the process started by running the following:
While those commands are running, finish reading the rest of this guide.
Pre-commit
----------
@ -265,6 +266,21 @@ Fork a Repo Guide_>`_ and is well worth reading.
Salt's Branch Topology
----------------------
Salt will only have one active branch - ``master``.
This will include bug fixes, features and CVE “Common Vulnerabilities and Exposures”.
The release will be cut from the master when the time comes for a new release,
which should be every 3 to 4 months.
To be able to merge code:
#. The code must have a well-written test.
Note that you are only expected to write tests for what you did, not the whole modules or function.
#. All tests must pass.
The SaltStack employee that reviews your pull request might request changes or deny the pull request for various reasons.
Salt uses a typical branch strategy - ``master`` is the next expected release.
Code should only make it to ``master`` once it's production ready. This means
that typical changes (fixes, features) should have accompanying tests.\
@ -276,8 +292,24 @@ SaltStack encourages using `the magic keywords to close a GitHub issue <Closing
issues via commit message_>`_. These should appear in the commit message text
directly.
Release Naming Convention
-------------------------
A new convention will start when Salt releases Salt 3000.
Every new release name will increment by one ‘Salt last_release_number + 1’.
This naming convention is very different from past releases, which was 'YYYY.MM.PATCH'.
Handling CVE
--------------
If a CVE is discovered, Salt will create a new release that **only** contains the tests and patch for the CVE.
This method should improve the upgrade process by reducing the chances of breaking something.
.. _backporting-pull-requests:
Backporting Pull Requests
-------------------------