When it comes to open source, there are different ways you can contribute, all of which are valuable. Here’s few guidelines that should help you as you prepare your contribution.
Before you start working on a contribution, create an issue describing what you want to build. It’s possible someone else is already working on something similar, or perhaps there is a reason that feature isn’t implemented. The maintainers will point you in the right direction.
The following steps will get you setup to contribute changes to this repo:
-
Fork this repo.
-
Clone your forked repo:
git clone [email protected]:{your_username}/houston.git -
Run
make dependenciesto install dependencies for the library and the sample app. -
Start playing with the code! You can do some experimentation with the sample app provided in the
examplefolder or start implementing a feature right away.
make test
- Runs all Vitest tests
make check-all
- Runs linting, format-checking, type-checking
make format
- Runs formatting on the codebase
Houston uses Vitest for testing. After implementing your contribution, write tests for it. Just create a new file under tests or add additional tests to the appropriate existing file.
Before submitting your PR, run make test to make sure there are no (unintended) breaking changes.
The Houston documentation lives in the README.md. Be sure to document any API changes you implement.
By contributing your code to the Houston GitHub repository, you agree to license your contribution under the BSD 3-Clause license.