fisher/CONTRIBUTING.md

35 lines
1.1 KiB
Markdown
Raw Normal View History

2016-02-11 05:18:43 +01:00
[![Slack Room][slack-badge]][slack-link]
# Contributing
2016-03-10 06:18:17 +01:00
If you are looking for ways to help, browse [open issues] or send us a PR if you are already working on something.
## Guidelines
* Fork the repo and create your feature branch from master.
* If you make significant changes, please add tests too. Get familiar with [Fishtape].
* If you've changed APIs, please update the documentation.
* Follow the [seven rules] of a great Git commit message.
## Plugins
2016-03-10 06:18:17 +01:00
1. Create a plugin from a template with [new].
2. Submit a plugin to the index with [submit].
## Translations
2016-03-10 06:18:17 +01:00
If you would like to translate the documentation, start with the [README].
2016-02-11 05:18:43 +01:00
[slack-link]: https://fisherman-wharf.herokuapp.com/
[slack-badge]: https://img.shields.io/badge/slack-join%20the%20chat-00B9FF.svg?style=flat-square
[seven rules]: http://chris.beams.io/posts/git-commit/#seven-rules
[open issues]: https://github.com/fisherman/fisherman/issues?q=is%3Aopen+is%3Aissue
[Fishtape]: https://github.com/fisherman/fishtape
2016-03-10 06:18:17 +01:00
[README]: https://github.com/fisherman/fisherman/blob/master/README.md
[new]: https://github.com/fishery/new
[submit]: https://github.com/fishery/submit