Contributing

Copied and adapted from Tide's Contributing guide.

Code Conventions

Style Guide

• if > and or or
• test > [...]
• printf > echo
• Long forms of flags > short forms
  • Note that MacOS utils often do not support long flags, in which case one should use the short option
• Piping > command substitution

Format

Fish code formatting is done via fish_indent, which is available as a VSCode plugin. Markdown and YAML formatting is done via Prettier, run with just the defaults.

Naming Conventions

All variables and functions should be named in snake_case. For variables and functions exposed to the user but not meant for the user to interact with, prepend an underscore in front of the name.

Testing

Dependencies

• jorgebucaran/fishtape - Runs Fish tests
• IlanCosman/clownfish - Mocks the behavior of commands

Run tests like so from the repository root

fishtape tests/*/*

Feature development

When developing new features or changing existing features, make sure to update the readme and add tests.