From add2247daf5269eff1005a344c19315307693c45 Mon Sep 17 00:00:00 2001 From: rallytime Date: Tue, 3 Oct 2017 15:51:32 -0400 Subject: [PATCH] Add information about release cadence to contributing file --- CONTRIBUTING.md | 18 ++++++++++++++++-- README.rst | 8 +++++++- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21a84c7..11614af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,8 +37,8 @@ Please read the following guidelines before you 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 -environment? What steps will reproduce the issue? What Operating System? What +Please try to be as detailed as possible in your report. 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. @@ -140,6 +140,20 @@ key to your GitHub account. Once these steps are completed, the commit signing verification will look like the example in GitHub's [GPG Signature Verification feature announcement](https://github.com/blog/2144-gpg-signature-verification). +## Release Cadence + +There is no defined release schedule for the bootstrap script at this time. +Typically, SaltStack's release team determines when it would be good to release +a new stable version. + +Timing the release usually involves an analysis of the following: + +- Updates for major feature releases in [Salt](https://github.com/saltstack/salt) +- Support for new versions of major operating systems +- Types of fixes submitted to `develop` since the last release +- Fixes needed for inclusion in an upcoming version of [Salt](https://github.com/saltstack/salt) +- Length of time since the last bootstrap release + ## Adding Support for Other Operating Systems The following operating systems are detected, but Salt and its dependency diff --git a/README.rst b/README.rst index 6ebb47f..3c4f72f 100644 --- a/README.rst +++ b/README.rst @@ -164,7 +164,7 @@ Or link them to the right place: Installing via an Insecure One-Liner ------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following examples illustrate how to install Salt via a one-liner. @@ -319,6 +319,12 @@ Please run the following commands and report their output when creating a ticket For information on how to add support for a currently unsupported distro, please refer to the `Contributing Guidelines`_. +Testing +------- + +There are a couple of ways to test the bootstrap script. Running the script on a full-fledged +VM is one way. Other options include using Vagrant or Docker. + Testing in Vagrant ==================