mirror of
https://github.com/jorgebucaran/fisher
synced 2024-06-28 23:01:50 +02:00
9a4f0f0650
* Improved README, added links to screencasts, updated documentation with new changes and fixed other typos and composition errors. * Removed `fisher update --cache` in favor of `fisher --cache | fisher update` and `fisher uninstall --all` in favor of `fisher --cache | fisher uninstall`. * Fisherman does not move initialization / configuration files following the convention `name`.config.fish to `$fisher_config/functions`, but to `$fisher_config/conf.d` now and evaluates each `*.config.fish` inside at shell start as usual. Closes #13. * Added `fisher --cache[=base]` option to retrieve contents in `$fisher_cache`, eliminating flaky usage of `find(1)`. Closes #11. * Fisherman now generates information about plugins installed via custom URLs. For the description, a shortened version of the URL is used. For the URL the full URL is used. For tags, the URL is fuzzily checked and tags such as _theme_, _plugin_, _config_ and _omf_ are added. The tag _orphan_ is added by default as well. Finally, the author is generated by retrieving the e-mail or username of the author of the first commit in the plugin's repository. Closes #9 and #14. * Changed `--path-in-cache` to `--translate.` This function translates an name or supported URL/URL variation into a path inside `$fisher_cache`. This allows you to treat plugins installed via custom URLs almost like regular plugins if they are installed. Closes #8. * Fixed a bug with `mktemp` failing on some systems. Closes #7. Thanks @tobywf. * Added [CODE_OF_CONDUCT][code_of_conduct]. Closes #6. * Fisherman can now unload themes within the same shell, without having to restart the session. Closes #5. * Fisherman can now load themes within the same shell, without having to restart the session using `exec fish`. Shoddy themes, for example those failing to declare global variables with the `-g` flag still require the session to be reset. See [**related**][bobthefish-19]. Closes #4. * Move `getopts` implementation to `share/getopts.awk`. Closes #3. * Support dots inside URIs in `fisher --validate`. Closes #2.
42 lines
1.4 KiB
Markdown
42 lines
1.4 KiB
Markdown
# Contributing to Fisherman
|
|
|
|
You can start contributing right away:
|
|
|
|
* [Join][join] the community.
|
|
* [Spread][tweet] the voice.
|
|
* Report [bugs][bugs].
|
|
|
|
If you are looking for other ways to help, peruse [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.
|
|
|
|
|
|
## Addons
|
|
|
|
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].
|
|
|
|
<!-- Links -->
|
|
|
|
[org]: https://github.com/fisherman
|
|
[join]: https://gitter.im/fisherman/wharf
|
|
[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
|
|
|
|
[tweet]: https://twitter.com/intent/tweet?url=https%3A%2F%2Fgit.io%2Ffisher&via=jbucaran&text=Check+out+%23Fisherman+for+the+%23fishshell
|
|
|
|
:anchor:
|