diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d5fd41d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing to polybar-scripts + +Thank you for your interest in improving polybar-scripts. + +Some things that have become standard: + +* The [skeleton](skeleton/). This is an example of how each script is structured to create a common structure. +* Use `#` or `#1`, `#2` .. as icon replacement in your scripts. Everyone use another icon font. So let the user decide which icon he wants to use. +* Remove your colors unless they have a special function. This way scripts remain customizable. + +## shell scripts + +* Use `shellcheck` to check your shell scripts for possible errors. Otherwise, travis-ci will do it for you. A good start to try [ShellCheck](https://www.shellcheck.net/) is their website. diff --git a/README.md b/README.md index 9f750e8..c802316 100644 --- a/README.md +++ b/README.md @@ -65,14 +65,3 @@ Is this your first time here? You should definitely take a look at these scripts * Save the script of your choice somewhere at `~/.config/polybar/` * Copy the module settings into your configuration file * Replace the appropriate icon strings in the script (e.g. replace `#1` with `🎉`). - - -## Development - -It's a good idea to look at the [skeleton](skeleton/). - -Most scripts are shell scripts. Use ShellCheck to check the code for possible errors. A good start to try [ShellCheck](https://www.shellcheck.net/) is their website. - -Use `#` or `#1`, `#2` .. as icon replacement in your scripts. Everyone use another icon font. So let the user decide which icon he wants to use. - -Remove your colors unless they have a special function. This way scripts remain customizable.