This repository was archived by the owner on May 14, 2024. It is now read-only.
File tree 2 files changed +41
-0
lines changed
2 files changed +41
-0
lines changed Original file line number Diff line number Diff line change
1
+ # How to contribute
2
+
3
+ First off, thanks for taking the time to contribute!
4
+
5
+ ## Submitting changes
6
+
7
+ Please send a GitHub Pull Request with a clear list of what you've done (read more about [ pull requests] ( http://help.github.com/pull-requests/ ) ).
8
+
9
+ Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
10
+
11
+ ```
12
+ $ git commit -m "A brief summary of the commit
13
+ >
14
+ > A paragraph describing what changed and its impact."
15
+ ```
16
+
17
+ ## Coding style
18
+
19
+ Start reading the code and you'll get the hang of it. It is optimized for readability:
20
+
21
+ * Variables must be uppercase and should begin with ` MY_ ` .
22
+ * Functions must be lower case.
23
+ * Check your shell scripts with [ ShellCheck] ( https://www.shellcheck.net/ ) before submitting.
24
+ * Please use tabs to indent.
25
+
26
+ One more thing:
27
+
28
+ * Keep it simple! 👍
29
+
30
+ Thanks! ❤️❤️❤️
Original file line number Diff line number Diff line change
1
+ First off, thanks for taking the time to contribute!
2
+
3
+ ## Please Complete the Following
4
+
5
+ - [ ] I read ` CONTRIBUTING.md `
6
+ - [ ] I used tabs to indent
7
+ - [ ] I checked my code with [ ShellCheck] ( https://www.shellcheck.net/ )
8
+
9
+ ## Notes
10
+
11
+ Feel free to put whatever you want here.
You can’t perform that action at this time.
0 commit comments