Skip to content

Commit aec7247

Browse files
author
serverco
authored
Create CONTRIBUTING.md
1 parent 36e3428 commit aec7247

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# How to contribute
2+
3+
If you are happy writing in bash, please create a PR for any changes you'd like to see included (or bug fixes).
4+
5+
If you aren't happy writing in bash, please open an issue with as much detail as possible about the issue or what you'd like to see added / improved.
6+
7+
## Submitting changes
8+
9+
Please update the 'revision history' and version number at the top of the code (without this I can't easily do a merge)
10+
11+
## Coding conventions
12+
13+
Please see the guidelines at https://github.com/srvrco/getssl/wiki/Bash-Style-guide
14+
15+
## Testing
16+
17+
Please test with [shellcheck](https://github.com/koalaman/shellcheck), although this will also be tested on github ( via travis) on all PRs.
18+
19+
Please remember that the system is used across a wide range of platforms, so if you have access to multiple operating systems, please test on all.
20+
21+
22+
Thanks :)

0 commit comments

Comments
 (0)