Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add contributing guidelines #27

Merged
merged 1 commit into from
Nov 24, 2020
Merged

Add contributing guidelines #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.