Contributing

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

Naming Conventions

Local variables should be named in camelCase.

• set -l numberOfNewlines

Anything exposed to the shell or user--functions, global/universal variables, and files--should be named in snake_case. For anything that the user is not meant to interact with directly, prepend an underscore in front.

Testing

Dependencies

• Fishtape - Runs fish tests
• 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.