Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Contributing

Patrick edited this page Feb 14, 2021 · 21 revisions

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

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.

Clone this wiki locally

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /