projects/fisher
1
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-07-02 23:11:48 +02:00
Code Issues Packages Projects Releases Wiki Activity
fisher/CONTRIBUTING.md

42 lines
1.3 KiB
Markdown
Raw Normal View History

Make Slack logo blue.
2016-02-11 05:18:43 +01:00
[![Slack Room][slack-badge]][slack-link]
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 15:13:29 +01:00
# Contributing
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
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 15:13:29 +01:00
If you are looking for ways to help, browse [open issues][issues] or send us your PR if you are already working on something.
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
## Guidelines
* Fork the repo and create your feature branch from master.
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 15:13:29 +01:00
* If you make significant changes, please add tests too. Get familiar with [Fishtape].
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
Add new plugins and translations sections.
2016-02-13 10:51:33 +01:00
* If you've changed APIs, please update the documentation.
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
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 15:13:29 +01:00
* Follow the [seven rules] of a great Git commit message.
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
Ahoy! Fisherman gets a super patch v0.3.1 This patch contains several amends for 0.3.0 and other minor documentation corrections. Major documentation revision and rewrite. fisher help shows fisher(1) by default now. Fix a critical bug that was causing fisher uninstall --force to remove not the symbolic link, but the actual files. Closes #24 Rename orphan tag to custom for plugins installed using a custom URL. warning Remove fisher --link flag and create symbolic links by default for local paths. The user does not have to worry about symbolic links or whether the copy is as symbolic link or not anymore. If the user tries to install a local path, then the best thing to do is to create a symbolic link. This also eliminates the need to call update. warning Remove fisher --cache and fisher --validate. Now, that these options are separated into their own function and they are intentionally private, there is no need for them.
2016-01-10 08:01:07 +01:00
## Plugins
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 22:12:40 +01:00
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 15:13:29 +01:00
1. Create a new plugin with `scaffold`.
```fish
fisher install scaffold
fisher scaffold
```
Add new plugins and translations sections.
2016-02-13 10:51:33 +01:00
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 15:13:29 +01:00
2. Submit a plugin to the [index] with `submit`.
```fish
fisher install submit
fisher submit my_plugin
```
Add new plugins and translations sections.
2016-02-13 10:51:33 +01:00
## Translations
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 15:13:29 +01:00
If you would like to translate a portion of the documentation, you can begin with the [Quickstart Guide].
Make Slack logo blue.
2016-02-11 05:18:43 +01:00
Add new plugins and translations sections.
2016-02-13 10:51:33 +01:00
[slack-link]: https://fisherman-wharf.herokuapp.com/
[slack-badge]: https://img.shields.io/badge/slack-join%20the%20chat-00B9FF.svg?style=flat-square
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 15:13:29 +01:00
[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
Add new plugins and translations sections.
2016-02-13 10:51:33 +01:00
[index]: https://github.com/fisherman/fisher-index
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 15:13:29 +01:00
[Quickstart Guide]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide
Reference in a new issue Copy permalink