Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
15 lines (9 loc) · 829 Bytes

CONTRIBUTING.md

File metadata and controls

15 lines (9 loc) · 829 Bytes

Contributing to polybar-scripts

Thank you for your interest in improving polybar-scripts.

Some things that have become standard:

  • The skeleton. This is an example of how each script is organized to create a common file 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.
  • Use #!/bin/sh as shebang. We don't know which shell is installed and we don't want to add a specific shell as a dependency.
  • Remove your colors unless they have a special function. This way scripts remain customizable.

Check your code

Use shellcheck to check your shell scripts for possible errors. Otherwise, GitHub CI will do it for you. A good start to try ShellCheck is their website.