Thank you for considering contributing to this project! Here's how you can help.
If you find a bug or have a feature request, please open an issue on GitHub after checking that there isn't already one.
Everyone is welcome to contribute with new features or bug fixes. Here's how you can do it:
- Fork the repository
- Clone your fork
- Create a new branch
- Make your changes
- (Optional) Add a changeset using
make changeset(orbunx changeset) - Commit your changes
- Push your changes to your fork
- Open a pull request
It is recommended to use Docker to test the project. You also have make commands available to help you.
| Command | Description |
|---|---|
start |
Start the project with Docker (installs dependencies and runs bun test --watch) |
restart |
Restart the containers. |
stop |
Stops the containers. |
down |
Removes the containers. |
ssh |
SSH into the running container. |
logs |
Prints the current log results (of the tests) to your terminal in watch mode. |
test |
Runs a standalone Docker container to run the tests once. |
build |
Generates the dist files for this library. |
lint |
Runs Prettier & ESLint (without formatting). |
format |
Formats the files according to Prettier & ESLint rules. |
changeset |
Creates a changeset. |
The usual workflow is to run make start and then make logs to see the test results in real time.
You can also develop without Docker, but tests have to be run inside a Docker container to test absolute paths. You can use make test for this purpose.
If you do not have make commands available, feel free to look inside the Makefile to see what commands are available and how to run them.
Feel free to also add useful commands to the Makefile and open a pull request.
Note
You can add a compose.override.yml file to override the default compose.yml file. This is useful if you need to make some changes for your OS.