Are you interested in contributing to bat-extras? That's great!
All we ask is that you keep a few things in mind:
- Use Bashisms whenever possible (unless it would make the code unclear). These are scripts written specifically for the
bashshell, and they should take advantage of built-in functionality instead of spawning external processes. - Use
awkorsedwhen it would be faster or less verbose than only usingbashbuiltins.
- Include crude or offensive language inside issues or scripts.
- Use GNU/BSD-only features in external programs like
sedorawk. - Use
bashfeatures that require a Bash version newer than 3.2. - Use
headin a pipe. See Issue #19 for more details. - Use any external program that isn't likely to come installed by default (e.g. avoid
perlandpython). - Automatically reformat scripts unless it's a pull request specifically intended for reformatting. The formatting style that we use differs from what
shfmtand other shell script formatters will emit.