IlanCosman/tide
1
1
Fork 0
mirror of https://github.com/IlanCosman/tide.git synced 2024-12-02 11:49:08 +03:00
Code Issues Projects Releases Wiki Activity
00be07c8e2
tide/CONTRIBUTING.md
Ilan Cosman 4a00c2f7ca Add contributing.md
2020-05-30 18:03:41 -07:00

859 B
Raw Blame History

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:

tide_install -d example-branch

tide_install -ld ~/tide

Testing

The tide_test command runs tests from the $__fish_config_dir/tests folder using fishtape. Currently there are unit tests for most prompt items.

Example:

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