mirror of
https://github.com/jorgebucaran/fisher
synced 2024-11-09 07:10:27 +00:00
707855203a
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.
46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# Contributing to Fisherman
|
|
|
|
[![Wharf][wharf-badge]][wharf-link]
|
|
|
|
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.
|
|
|
|
## Guidelines
|
|
|
|
* Fork the repo and create your feature branch from master.
|
|
|
|
* Test before you push. Get familiar with **[Fishtape][fishtape]**.
|
|
|
|
* If you've changed APIs, update the documentation.
|
|
|
|
* Follow the [seven rules][seven-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`.
|
|
|
|
To browse the available content use `fisher search` or see the [Fisherman Index][fisher-index].
|
|
|
|
:anchor:
|
|
|
|
|
|
<!-- Links -->
|
|
|
|
[org]: https://github.com/fisherman
|
|
|
|
[bugs]: https://github.com/fisherman/fisherman/issues
|
|
|
|
[issues]: https://github.com/fisherman/fisherman/issues?q=is%3Aopen+is%3Aissue
|
|
|
|
[fishtape]: https://github.com/fisherman/fishtape
|
|
|
|
[fish-docs]: http://fishshell.com/docs/current/index.html
|
|
|
|
[seven-rules]: http://chris.beams.io/posts/git-commit/#seven-rules
|
|
|
|
[fisher-index]: https://github.com/fisherman/fisher-index
|
|
|
|
[wharf-link]: https://fisherman-wharf.herokuapp.com/
|
|
|
|
[wharf-badge]: https://img.shields.io/badge/wharf-join%20the%20chat-00cc99.svg?style=flat-square
|