mirror of
https://github.com/jorgebucaran/fisher
synced 2024-11-03 15:40:27 +00:00
34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
[![Slack Room][slack-badge]][slack-link]
|
|
|
|
# Contributing
|
|
|
|
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
|
|
|
|
1. Create a plugin from a template with [new].
|
|
2. Submit a plugin to the index with [submit].
|
|
|
|
## Translations
|
|
|
|
If you would like to translate the documentation, start with the [README].
|
|
|
|
[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
|
|
[README]: https://github.com/fisherman/fisherman/blob/master/README.md
|
|
[new]: https://github.com/fishery/new
|
|
[submit]: https://github.com/fishery/submit
|