Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 1.87 KB

Contribution Guidelines

Contributions are welcome! Here's how you can help:

  • Report a bug: If you find a bug, please open an issue.
  • Request a feature: If you have an idea for a feature, please open an issue.
  • Create a pull request: If you can fix a bug or implement a feature, please create a pull request (I promise a quick review).
  • Use Wabe: The best way to contribute is to use Wabe for your backend.

Note: Each code contribution must be tested either by an existing test or a new one.

Note about new PR

First of all, thanks you for taking time to improve Wabe. Wabe have a great test coverage, to keep this code quality, please add tests that cover your changes 🙂.

Install

Wabe uses Bun, so you need the latest version of Bun. You can see here if Bun is not installed on your machine.

Wabe uses a monorepo organization, all the packages are under the packages directory.

Once you have cloned the repository you can run the following command at the root of the project.

bun install

You can run the tests in all packages by running the following commands at the root repository:

cd packages/wabe
bun dev # Run server and create all codegen

bun test # Run test on wabe package
# or
bun ci # Run lint + test on package

Pre-commit

Before any commit a pre-commit command that will run on your machine to ensure that the code is correctly formatted and the lint is respected. If you have any error of formatting during the pre-commit you can simply run the following command (at the root of the repository):

Wabe repository also uses the conventional commits to ensure a consistence and facilitate the release. Yours PR and yours commits need to follow this convention. You can see here to see more information about Conventional commits.

bun format