Ekdohibs
/
polybar-scripts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add CONTRIBUTING.md

master
x70b1 2018-04-17 03:15:46 +02:00
parent 7d8ea3e067
commit 550bfe9388
2 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md Normal file
View File

@ -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.

11
README.md
View File

@ -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.