Skip to content

Latest commit

 

History

History
60 lines (33 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

60 lines (33 loc) · 1.71 KB

How Can I Contribute?

All contributions welcome!

Open issue

If you found a bug, have an idea for improvement or just wanted to ask some questions, please take a look if we have already opened Issue covering it where you may add a comment. If it isn't covered there, please open a new Issue and describe the problem.

Open pull request

If you want to fix some bug, typo or implement an idea by yourself don't hesitate from opening a new Pull request. You may also help to review an existing one.

Here are couple of resources which may help you with writing shell scripts:

Installation:

pacman -Syu shellcheck

Usage:

shellcheck -x "file"

See shellcheck -h or man shellcheckfor help.

Installation:

pacman -Syu shellharden

Usage:

Output a colored diff suggesting changes:

shellharden --suggest "file"

Replace file contents with suggested changes:

shellharden --replace "file"

See shellharden -h for help.

Installation:

pacman -Syu shfmt

Usage:

Error with a diff when the formatting differs:

shfmt -i 2 -ci -d "file"

Write result to file instead of stdout:

shfmt -i 2 -ci -w "file"

See shfmt -h for help.

Thanks for taking the time to contribute to our project!