Merge pull request #27 from olhado/contribute

Add contributing guidelines
threatstack · Nov 24, 2020 · 753cece · 753cece
2 parents 0e8cf97 + 49f1b44
commit 753cece
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+Contributing to Threat Stack Agent Salt Formula 
+=============================
+
+We encourage anyone to provide enchancements/fixes to this repository. Simply fork, commit, and then open a PR back to the parent repository.
+
+
+### What makes a good PR?
+
+* Make sure you update the README.md with any new/removed/changed values parameters.
+* Write tests that cover your proposed changes.
+* Make sure the tests documented in the [README](README.md) run as expected on all platforms.
diff --git a/README.md b/README.md
@@ -52,3 +52,7 @@ This method requires updating `deploy_key` pillar item in `pillar.example` to a
 <Edit `pillar.example`>
 bundle exec kitchen test
 ```
+
+## Contributing enhancements/fixes
+
+See the [CONTRIBUTING document](CONTRIBUTING.md) for details.