mirror of
https://github.com/jorgebucaran/fisher
synced 2024-10-09 09:36:53 +02:00
Add new plugins and translations sections.
This commit is contained in:
parent
36f9fc85d8
commit
1f16aa1521
1 changed files with 45 additions and 11 deletions
|
@ -2,25 +2,54 @@
|
||||||
|
|
||||||
# Contributing to Fisherman
|
# 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.
|
If you are looking for ways to help, peruse the [open issues][issues] or send us your PR if you are already working on something.
|
||||||
|
|
||||||
## Guidelines
|
## Guidelines
|
||||||
|
|
||||||
* Fork the repo and create your feature branch from master.
|
* Fork the repo and create your feature branch from master.
|
||||||
|
|
||||||
* Test before you push. Get familiar with [Fishtape][fishtape].
|
* If you make significant changes, please add tests too. Get familiar with [Fishtape][fishtape].
|
||||||
|
|
||||||
* If you've changed APIs, update the documentation.
|
* If you've changed APIs, please update the documentation.
|
||||||
|
|
||||||
* Follow the [seven rules][commits] of a great git commit message.
|
* Follow the [seven rules][rules] of a great git commit message.
|
||||||
|
|
||||||
## Plugins
|
## 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`.
|
The fastest way to create a plugin is using the `scaffold` plugin.
|
||||||
|
|
||||||
|
1. Install
|
||||||
|
|
||||||
|
```fish
|
||||||
|
fisher install scaffold
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a new plugin using the default template.
|
||||||
|
> See the `fisher help scaffold` for other usage instructions.
|
||||||
|
|
||||||
|
```fish
|
||||||
|
fisher scaffold
|
||||||
|
```
|
||||||
|
|
||||||
To browse the available content use `fisher search` or browse the [Fishery][fishery].
|
To browse the available content use `fisher search` or browse the [Fishery][fishery].
|
||||||
|
|
||||||
:anchor:
|
To submit a new plugin to the [index][index], use the `submit` plugin.
|
||||||
|
|
||||||
|
1. Install
|
||||||
|
|
||||||
|
```fish
|
||||||
|
fisher install submit
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Submit
|
||||||
|
|
||||||
|
```fish
|
||||||
|
fisher submit my_plugin
|
||||||
|
```
|
||||||
|
|
||||||
|
## Translations
|
||||||
|
|
||||||
|
If you would like to translate a portion of the documentation, you can begin with the [Quickstart Guide][quick-start]. Use any of the existing translations as a reference to get started.
|
||||||
|
|
||||||
<!-- Badges -->
|
<!-- Badges -->
|
||||||
|
|
||||||
|
@ -29,10 +58,15 @@ To browse the available content use `fisher search` or browse the [Fishery][fish
|
||||||
|
|
||||||
<!-- Links -->
|
<!-- Links -->
|
||||||
|
|
||||||
|
[rules]: http://chris.beams.io/posts/git-commit/#seven-rules
|
||||||
[issues]: https://github.com/fisherman/fisherman/issues?q=is%3Aopen+is%3Aissue
|
[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
|
[fishtape]: https://github.com/fisherman/fishtape
|
||||||
|
|
||||||
<!-- Plugins -->
|
<!-- Plugins -->
|
||||||
|
|
||||||
|
[index]: https://github.com/fisherman/fisher-index
|
||||||
[fishery]: https://github.com/fishery
|
[fishery]: https://github.com/fishery
|
||||||
|
|
||||||
|
<!-- Translations -->
|
||||||
|
|
||||||
|
[quick-start]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide
|
||||||
|
|
Loading…
Reference in a new issue