IlanCosman/tide
1
1
Fork 0
mirror of https://github.com/IlanCosman/tide.git synced 2024-11-23 08:46:51 +03:00
Code Issues Projects Releases Wiki Activity

Add contributing.md

Browse Source
This commit is contained in:
Ilan Cosman 2020-05-30 18:03:41 -07:00
parent 70e431d66b
commit 4a00c2f7ca
2 changed files with 40 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,33 @@
# Contributing
🌊 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:
```fish
tide_install -d example-branch
```
```fish
tide_install -ld ~/tide
```
## Testing
The `tide_test` command runs tests from the `$__fish_config_dir/tests` folder using [fishtape](https://github.com/jorgebucaran/fishtape). Currently there are unit tests for most prompt items.
Example:
```fish
tide_test status
```
## Git Workflow
1. Fork this repository
2. Make some changes, committing them along the way
3. Create a pull request from your branch to `IlanCosman/tide`

10
README.md
View File

@ -1,4 +1,4 @@
# Tide ![Fish_Version_Shield](https://img.shields.io/badge/fish-3.1.0-blue)
# 🌊 Tide ![Fish_Version_Shield](https://img.shields.io/badge/fish-3.1.0-blue)
Tide is a Fish theme inspired by [Powerlevel10k](https://github.com/romkatv/powerlevel10k/). It aims to provide a powerful, flexible, and out-of-the-box experience.
@ -16,7 +16,7 @@ curl -sL git.io/tide-fish | source; and tide_install
### Multi-Line Right Prompt
> Fish cant do _that_ yet can it?
> Fish can't do _that_ yet can it?
![Multi-Line_Right_Prompt](/media/images/Multi-Line_Right_Prompt.png)
@ -32,6 +32,10 @@ If there isn't a prompt item that fits your needs, make your own!
![Extensible](/media/images/Extensible.png)
# Contributing
If you're interested in helping contribute to Tide, please take a look at the [Contributing Guide](https://github.com/IlanCosman/tide/blob/master/CONTRIBUTING.md).
# Configuration
Tide variables that users are encouraged to modify begin with the string `tide_`. Thus, variables in this section will be denoted as `example_variable` but will actually be `tide_example_variable`.
@ -44,7 +48,7 @@ Tide variables that users are encouraged to modify begin with the string `tide_`
| left_prompt_items | order of the left prompt items to display | 'pwd' 'git_prompt' 'newline' 'prompt_char' |
| right_prompt_items | order of the right prompt items to display | 'status' 'cmd_duration' 'context' 'jobs' |
### prompt connection
### prompt_connection
| Variable | Description | Default |
| ----------------------- | --------------------------------------------------------------------- | ------- |