mirror of
https://github.com/jorgebucaran/fisher
synced 2024-11-09 07:10:27 +00:00
2cbbb00dcb
* Deprecate fisher --list in favor of a new command fisher list. The behavior is roughly the same. See fisher help list for usage. tl;dr: Use list to query the local system / cache and search to query the index. * Teach fisher_plugin_walk about fish_postexec, fish_command_not_found and fish_preexec event emitters and erase them during uninstall if they were defined in a snippet. * Fisherman now recognizes the following aliases by default: i for install, u for update, l for list, s for search and h for help. * Large documentation rewrite. Better, simpler, more concise and more consistent. * Fisherman now detects if users have modified their fish prompt using fish_config and if so, uninstalls $fisher_prompt.
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
[![Slack Room][slack-badge]][slack-link]
|
|
|
|
# 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.
|
|
|
|
## 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
|
|
|
|
1. Create a new plugin with `scaffold`.
|
|
```fish
|
|
fisher install scaffold
|
|
fisher scaffold
|
|
```
|
|
|
|
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].
|
|
|
|
[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
|