Skip to content

Commit 753cece

Browse files
authored
Merge pull request #27 from olhado/contribute
Add contributing guidelines
2 parents 0e8cf97 + 49f1b44 commit 753cece

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Contributing to Threat Stack Agent Salt Formula
2+
=============================
3+
4+
We encourage anyone to provide enchancements/fixes to this repository. Simply fork, commit, and then open a PR back to the parent repository.
5+
6+
7+
### What makes a good PR?
8+
9+
* Make sure you update the README.md with any new/removed/changed values parameters.
10+
* Write tests that cover your proposed changes.
11+
* Make sure the tests documented in the [README](README.md) run as expected on all platforms.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,7 @@ This method requires updating `deploy_key` pillar item in `pillar.example` to a
5252
<Edit `pillar.example`>
5353
bundle exec kitchen test
5454
```
55+
56+
## Contributing enhancements/fixes
57+
58+
See the [CONTRIBUTING document](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)