fisher/CONTRIBUTING.md
Jorge Bucaran ebec1eaa01
Fisherman 1.0 RC
* 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.
2016-02-29 23:13:29 +09:00

1.3 KiB

Slack Room

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.
fisher install scaffold
fisher scaffold
  1. Submit a plugin to the index with submit.
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.