mirror of
https://github.com/eth-p/bat-extras.git
synced 2024-11-07 16:24:06 +01:00
1.1 KiB
1.1 KiB
Contributing
Are you interested in contributing to bat-extras
? That's great!
All we ask is that you keep a few things in mind:
DOs:
- Use Bashisms whenever possible (unless it would make the code unclear). These are scripts written specifically for the
bash
shell, and they should take advantage of built-in functionality instead of spawning external processes. - Use
awk
orsed
when it would be faster or less verbose than only usingbash
builtins.
DON'Ts:
- Include crude or offensive language inside issues or scripts.
- Use GNU/BSD-only features in external programs like
sed
orawk
. - Use
bash
features that require a Bash version newer than 3.2. - Use
head
in a pipe. See Issue #19 for more details. - Use any external program that isn't likely to come installed by default (e.g. avoid
perl
andpython
). - Automatically reformat scripts unless it's a pull request specifically intended for reformatting. The formatting style that we use differs from what
shfmt
and other shell script formatters will emit.