oh-my-fish/CONTRIBUTING.md
2015-06-17 12:52:32 -03:00

1.1 KiB

Contributing

We love pull requests. Here's a quick guide.

Fork and make your change. Make sure the tests pass:

./script/run-tests.fish -v

Push to your fork and submit a pull request.

At this point you're waiting on us. We usually comment on pull requests within a few hours. We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

Style Guide

  • Indentation should follow the "2-space convention".
  • Keep line length to a maximum of 100 characters.

Plugins

If your plugin is complex, make sure to include tests, we suggest using fish-spec.

Themes

Make sure to include a screenshot in your pull request, but don't commit the file to git. A nifty way is too post a comment with the image and link directly to it.