2020-05-31 04:03:41 +03:00
# Contributing
🌊 Thank you for contributing to Tide! 🌊
2020-08-09 04:49:19 +03:00
Please note that this project is released with a [Code of Conduct][]. By contributing to this project you agree to abide by its terms.
2020-05-31 04:03:41 +03:00
2020-08-09 04:49:19 +03:00
If you have any questions that aren't addressed in this document, please don't hesitate to open an issue!
2020-05-31 04:03:41 +03:00
2020-07-19 23:35:19 +03:00
## Code Conventions
2020-05-31 04:03:41 +03:00
2020-07-19 23:35:19 +03:00
### Style Guide
- `if` > `and` or `or`
2020-07-23 21:33:51 +03:00
- `test` > `[...]`
2020-07-23 20:57:40 +03:00
- `printf` > `echo`
2020-07-21 00:11:59 +03:00
- Long forms of flags > short forms
2020-07-23 20:57:40 +03:00
- Exceptions: `set` , `set_color` , `function foo -a` , "common knowledge" options for commands like `rm -r`
2020-08-12 20:44:44 +03:00
- Note that MacOS utils often do not support long flags, in which case one should use the short option
2020-07-23 21:33:51 +03:00
- Piping > command substitution (only when convenient, i.e no extra commands)
2020-07-19 23:35:19 +03:00
### Naming Conventions
Local variables should be named in `camelCase` .
- `set -l numberOfNewlines`
2020-07-23 21:33:51 +03:00
Anything exposed to the shell or user--functions, global/universal variables, and files--should be named in `snake_case` , beginning with `tide_` . Prepend an underscore if the user in not meant to interact directly with it.
2020-07-19 23:35:19 +03:00
- `set -g _tide_left_prompt_height`
- `set -U tide_right_prompt_items`
- `_tide_count_left_prompt_height.fish`
- `_tide_right_prompt`
#### Specific Naming Conventions
- Items begin with `_tide_item_`
- Subcommands begin with `_tide_sub_`
2020-06-16 05:52:37 +03:00
2020-08-09 04:49:19 +03:00
## Testing
2020-09-24 02:50:34 +03:00
### Dependencies
- [spout][] - 100% pure-fish TAP-based test runner
- [clownfish][] - override the behavior of commands
2020-12-26 03:32:03 +03:00
You can quickly install the necessary dependencies using `tide test -i` .
2020-09-24 02:50:34 +03:00
`tide test` runs tests from the `$_tide_dir/tests` directory.
2020-08-09 04:49:19 +03:00
Example:
```console
tide test status
```
You can run the full test suite with the `-a/--all` flag.
```console
tide test -a
```
2020-08-12 20:44:44 +03:00
Some tests are designed for a CI machine and will not necessarily run on any working Tide install. These tests can be run using the `--CI` flag.
2020-08-02 23:35:29 +03:00
## Linting
2020-08-09 04:49:19 +03:00
Code linting is done via [`fish --no-execute`][].
Markdown and Yaml linting is done via the [Super-Linter][] action, which uses [Markdownlint][] and [Yamllint][].
2020-08-02 23:35:29 +03:00
## Formatting
2020-08-09 04:49:19 +03:00
Code formatting is done via [`fish_indent`][].
2020-08-02 23:35:29 +03:00
Markdown and Yaml formatting is done via [Prettier][].
2020-08-09 04:49:19 +03:00
## Documentation Conventions
All links should be in the [reference style][], with references at the bottom of the document in alphabetical order.
2020-09-17 01:25:33 +03:00
## Release
2020-08-09 04:49:19 +03:00
2020-09-17 01:25:33 +03:00
Note that Tide does not use strict semantic versioning.
2020-08-09 04:49:19 +03:00
2020-09-17 01:25:33 +03:00
Todo on release:
2020-08-09 04:49:19 +03:00
2020-11-27 20:55:45 +03:00
- [ ] Update version number in install `tide.fish`
- [ ] Make a commit containing above edit, titled with the version number
- [ ] Create release on github with information from changelog
2020-08-09 04:49:19 +03:00
[`fish --no-execute`]: https://fishshell.com/docs/current/cmds/fish.html
[`fish_indent`]: https://fishshell.com/docs/current/cmds/fish_indent.html
2020-09-24 02:50:34 +03:00
[clownfish]: https://github.com/IlanCosman/clownfish
2020-09-07 22:00:54 +03:00
[code of conduct]: CODE_OF_CONDUCT.md
2020-11-04 22:05:41 +03:00
[fisher]: https://github.com/jorgebucaran/fisher
2020-08-09 04:49:19 +03:00
[markdownlint]: https://github.com/DavidAnson/markdownlint
2020-08-02 23:35:29 +03:00
[prettier]: https://github.com/prettier/prettier
2020-08-09 04:49:19 +03:00
[reference style]: https://www.markdownguide.org/basic-syntax/#reference-style-links
2020-09-13 08:46:32 +03:00
[spout]: https://github.com/IlanCosman/spout
2020-08-02 23:35:29 +03:00
[super-linter]: https://github.com/github/super-linter
2020-08-09 04:49:19 +03:00
[yamllint]: https://github.com/adrienverge/yamllint