fisher/CONTRIBUTING.md
2016-02-11 13:18:43 +09:00

39 lines
1.2 KiB
Markdown

[![Slack Room][slack-badge]][slack-link]
# Contributing to Fisherman
If you are looking for ways to help, peruse the [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][commits] of a great git commit message.
## Plugins
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 browse the [Fishery][fishery].
:anchor:
<!-- Badges -->
[slack-link]: https://fisherman-wharf.herokuapp.com/
[slack-badge]: https://img.shields.io/badge/slack-join%20the%20chat-00B9FF.svg?style=flat-square
<!-- Links -->
[issues]: https://github.com/fisherman/fisherman/issues?q=is%3Aopen+is%3Aissue
[commits]: http://chris.beams.io/posts/git-commit/#seven-rules
[fishtape]: https://github.com/fisherman/fishtape
<!-- Plugins -->
[fishery]: https://github.com/fishery