Archives/fisher
2
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-11-03 15:40:27 +00:00
Code Issues Projects Releases Wiki Activity
bca448d6ec
fisher/CONTRIBUTING.md
Jorge Bucaran 1f16aa1521
Add new plugins and translations sections.
2016-02-13 18:51:33 +09:00

1.8 KiB
Raw Blame History

Slack Room

Contributing to Fisherman

If you are looking for ways to help, peruse the open issues or send us your 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

The fastest way to create a plugin is using the scaffold plugin.

  1. Install

    fisher install scaffold

  2. Create a new plugin using the default template.

    See the fisher help scaffold for other usage instructions.

    fisher scaffold

To browse the available content use fisher search or browse the Fishery.

To submit a new plugin to the index, use the submit plugin.

  1. Install

    fisher install submit

  2. Submit

    fisher submit my_plugin

Translations

If you would like to translate a portion of the documentation, you can begin with the Quickstart Guide. Use any of the existing translations as a reference to get started.