summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: dbf930889beaad8ed79581e344ebc8c3da218ce1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# How to contribute

First off, thanks for taking the time to contribute!

## Submitting changes

Please send a [GitHub Pull Request](https://github.com/Cyclenerd/gallery_shell/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

```
$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."
```

## Coding style

Start reading the code and you'll get the hang of it. It is optimized for readability:

* Variables must be uppercase and should begin with `MY_`.
* Functions must be lower case.
* Check your shell scripts with [ShellCheck](https://www.shellcheck.net/) before submitting.
* Please use tabs to indent.

One more thing:

* Keep it simple! 👍

Thanks! ❤️❤️❤️