You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
fisher/CONTRIBUTING.md

36 lines
1.3 KiB
Markdown

# 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][seven-rules] 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 see the [Fisherman Index][fisher-index].
:anchor:
<!-- Links -->
[org]: https://github.com/fisherman
[bugs]: https://github.com/fisherman/fisherman/issues
[issues]: https://github.com/fisherman/fisherman/issues?q=is%3Aopen+is%3Aissue
[fishtape]: https://github.com/fisherman/fishtape
[fish-docs]: http://fishshell.com/docs/current/index.html
[seven-rules]: http://chris.beams.io/posts/git-commit/#seven-rules
[fisher-index]: https://github.com/fisherman/fisher-index
[wharf-link]: https://fisherman-wharf.herokuapp.com/
[wharf-badge]: https://img.shields.io/badge/wharf-join%20the%20chat-00cc99.svg?style=flat-square