Formula Guidelines

guidelines.md

Intended Audience

This document is intended as a set of loose guidelines for people with commit access to the saltstack-formulas GitHub organization. This is not meant for people who just want to make changes to formulas except as a reference for what committers tend to look out for in pull requests.

Intro

Formulas are commonly used by many SaltStack users, as such, we have certain guidelines we should all attempt to follow to ensure they continue to function in the manner to which people have become accustomed.

Guidelines

1. No committing to master

• You should never commit directly to master
• All commits should go through the normal pull request process whether it's a one character change or a 4000+ line change

2. No merging your own pull requests

• You should always have someone else review and merge your pull requests

3. Support last 2 major releases

• When possible, we should attempt a best effort to maintain backward compatibility for the previous 2 releases
• That doesn't necesarily mean testing every change across a matrix of versions, best effort is good enough
• That does however mean when someone points out broken backward compatibility, that we move quickly to fix the issue by either reverting or fixing it some other way

4. You should be subscribed to the saltstack-formulas list

• Important announcements for people interested in formulas are posted there
• https://groups.google.com/forum/#!forum/salt-formulas

5. Maintain backward compatibility whenever possible
6. Don't merge a pull request that someone else has asked for clarification on (questions on pull requests, line comments, etc).

1. Pull request should have
   • squash merged, with a commit message that explains all the changes in the pull
   • The Description in the GUI should be of the following format:

**Summary of Text**
Changed So on And So Forth
- change 1
- change 2
- change 3

**Tests**
- tested on OS 1 
- tested on OS 2
- presumed working on rest of OS's