|
|
|
@ -2,7 +2,7 @@
|
|
|
|
|
|
|
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
If you are looking for ways to help, browse [open issues][issues] or send us your PR if you are already working on something.
|
|
|
|
|
If you are looking for ways to help, browse [open issues] or send us a PR if you are already working on something.
|
|
|
|
|
|
|
|
|
|
## Guidelines
|
|
|
|
|
|
|
|
|
@ -16,26 +16,19 @@ If you are looking for ways to help, browse [open issues][issues] or send us you
|
|
|
|
|
|
|
|
|
|
## Plugins
|
|
|
|
|
|
|
|
|
|
1. Create a new plugin with `scaffold`.
|
|
|
|
|
```fish
|
|
|
|
|
fisher install scaffold
|
|
|
|
|
fisher scaffold
|
|
|
|
|
```
|
|
|
|
|
1. Create a plugin from a template with [new].
|
|
|
|
|
2. Submit a plugin to the index with [submit].
|
|
|
|
|
|
|
|
|
|
2. Submit a plugin to the [index] with `submit`.
|
|
|
|
|
```fish
|
|
|
|
|
fisher install submit
|
|
|
|
|
fisher submit my_plugin
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Translations
|
|
|
|
|
|
|
|
|
|
If you would like to translate a portion of the documentation, you can begin with the [Quickstart Guide].
|
|
|
|
|
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
|
|
|
|
|
[index]: https://github.com/fisherman/fisher-index
|
|
|
|
|
[Quickstart Guide]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide
|
|
|
|
|
[README]: https://github.com/fisherman/fisherman/blob/master/README.md
|
|
|
|
|
[new]: https://github.com/fishery/new
|
|
|
|
|
[submit]: https://github.com/fishery/submit
|
|
|
|
|