fisher/CONTRIBUTING.md
2016-01-02 06:12:40 +09:00

39 lines
1.4 KiB
Markdown

# Contributing to Fisherman
You can start contributing right away:
* [Join][join] the community.
* [Spread][tweet] the voice.
* [Bugs][bugs]? :beetle:
If you are looking for other ways to help, peruse [open issues][issues]. If you are already working on something, feel free to send us a PR.
## Guidelines
* Fork the repo and create your feature branch from master.
* Test before you push. Get familiar with [Fishtape][fishtape].
* If you've changed APIs, update the documentation.
* Follow the [seven rules][seven-rules] of a great git commit message.
## Addons
Third-party plugins are essential for keeping this project exciting. To learn how to create your own plugins and other extensions see `fisher help plugins`.
To browse the available content use `fisher search` or see the [Fisherman Index][fisher-index].
<!-- -->
[org]: https://github.com/fisherman
[fishtape]: https://github.com/fisherman/fishtape
[join]: https://gitter.im/fisherman/wharf
[bugs]: https://github.com/fisherman/fisherman/issues
[issues]: https://github.com/fisherman/fisherman/issues?q=is%3Aopen+is%3Aissue
[fish-docs]: http://fishshell.com/docs/current/index.html
[seven-rules]: http://chris.beams.io/posts/git-commit/#seven-rules
[tweet]: https://twitter.com/intent/tweet?url=https%3A%2F%2Fgit.io%2Ffisher&via=jbucaran&text=Check+out+%23Fisherman+for+the+%23fishshell
[fisher-index]: https://github.com/fisherman/fisher-index