projects/fisher
1
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-06-28 23:01:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add new plugins and translations sections.

Browse source
This commit is contained in:
Jorge Bucaran 2016-02-13 18:51:33 +09:00
parent 36f9fc85d8
commit 1f16aa1521
No known key found for this signature in database
GPG key ID: E54BA3C0E646DB30
1 changed files with 45 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
CONTRIBUTING.md
View file

@ -2,37 +2,71 @@
# 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
* 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
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].
: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 -->
[slack-link]: https://fisherman-wharf.herokuapp.com/
[slack-badge]: https://img.shields.io/badge/slack-join%20the%20chat-00B9FF.svg?style=flat-square
[slack-link]: https://fisherman-wharf.herokuapp.com/
[slack-badge]: https://img.shields.io/badge/slack-join%20the%20chat-00B9FF.svg?style=flat-square
<!-- Links -->
[issues]: https://github.com/fisherman/fisherman/issues?q=is%3Aopen+is%3Aissue
[commits]: http://chris.beams.io/posts/git-commit/#seven-rules
[rules]: http://chris.beams.io/posts/git-commit/#seven-rules
[issues]: https://github.com/fisherman/fisherman/issues?q=is%3Aopen+is%3Aissue
[fishtape]: https://github.com/fisherman/fishtape
<!-- Plugins -->
[fishery]: https://github.com/fishery
[index]: https://github.com/fisherman/fisher-index
[fishery]: https://github.com/fishery
<!-- Translations -->
[quick-start]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide