IlanCosman/tide
1
1
Fork 0
mirror of https://github.com/IlanCosman/tide.git synced 2024-11-24 01:13:13 +03:00
Code Issues Projects Releases Wiki Activity

Update contributing guide

Browse Source
This commit is contained in:
Ilan Cosman 2020-07-14 08:31:27 -07:00
parent 8ffc1369a2
commit 50cf3aa5ba
4 changed files with 16 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -30,3 +30,5 @@ If applicable, add screenshots to help explain your problem.
**Additional context**
Add any other context about the problem here.
![blah](/resources/images/Extensible.png)

22
CONTRIBUTING.md
View File

@ -2,23 +2,9 @@
🌊 Thank you for contributing to Tide! 🌊
## Installing for Developers
The `tide_install` function offers a few flags. `-d` will install Tide as a developer which provides extra files for testing. `-l` will install Tide from a local directory. When installing remotely, `tide_install` takes a branch name as an argument, defaulting to master.
Examples:
```console
tide_install -d example-branch
```
```console
tide_install -ld ~/tide
```
## Testing
The `tide test` command runs tests from the `$_tide_dir/tests` folder using [fishtape][]. Currently there are unit tests for most prompt items.
The `tide test` command runs tests from the `$_tide_dir/tests` folder using [fishtape][]. Currently there are unit tests for most prompt items. You can quickly install fisher and fishtape using `tide test -i`
Example:
@ -26,6 +12,12 @@ Example:
tide test status
```
You can run all tests with the `-a` flag.
```console
tide test -a
```
## Git Workflow
1. Fork this repository

12
README.md
View File

@ -179,20 +179,20 @@ Open each file and click "Install". This will make the `Sauce Code Pro` font ava
[ci]: https://github.com/IlanCosman/tide/actions?query=workflow%3ACI
[ci_badge]: https://github.com/IlanCosman/tide/workflows/CI/badge.svg
[configuration_wizard]: ./resources/svgs/Configuration_Wizard.svg
[configuration_wizard]: /resources/svgs/Configuration_Wizard.svg
[contributing guide]: https://github.com/IlanCosman/tide/blob/master/CONTRIBUTING.md
[extensible]: ./resources/images/Extensible.png
[extensible]: /resources/images/Extensible.png
[fish]: https://github.com/fish-shell/fish-shell
[fish_git_prompt]: https://fishshell.com/docs/current/cmds/fish_git_prompt.html
[fish_version_badge]: https://img.shields.io/badge/fish-3.1.0%2B-blue
[git]: https://github.com/git/git
[license]: ./LICENSE.md
[license]: /LICENSE.md
[license_badge]: https://img.shields.io/github/license/IlanCosman/tide
[multi-line_right_prompt]: ./resources/images/Multi-Line_Right_Prompt.png
[multi-line_right_prompt]: /resources/images/Multi-Line_Right_Prompt.png
[powerlevel10k]: https://github.com/romkatv/powerlevel10k/
[prompt_connection]: ./resources/images/Prompt_Connection.png
[prompt_connection]: /resources/images/Prompt_Connection.png
[pure]: https://github.com/rafaelrinaldi/pure
[pure_compatibility]: ./resources/svgs/Pure_Compatibility.svg
[pure_compatibility]: /resources/svgs/Pure_Compatibility.svg
[releases]: https://github.com/IlanCosman/tide/releases
[release_badge]: https://img.shields.io/github/v/release/IlanCosman/tide?label=%20
[sauce code pro bold.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Bold/complete/Sauce%20Code%20Pro%20Bold%20Nerd%20Font%20Complete.ttf