deno.land / x / alosaur@v1.1.1 / CONTRIBUTION.md
Any contribution to Alosaur is more than welcome!
A great way to contribute to the project is to send a detailed report when you encounter an issue. Please make sure to include a reproduction repository so that bugs can be reproduced without great efforts. The better a bug can be reproduced, the faster we can start fixing it!
We'd love to see your pull requests, even if it's just to fix a typo!
However, any significant improvement should be associated to an existing feature request or bug report.
A great PR, whether it includes a bug fix or a new feature, will often include tests. To write great tests, let us explain our test structure:
The unit tests can be found in *file*.test.ts
.
We really love e2e tests that can cover all cases. The unit tests can be found in e2e/*server_name*.test.ts
. We
usually write tests to servers in the examples/
folder.
Run all tests:
deno test -A --config ./src/tsconfig.lib.json
deno run -A --config ./src/tsconfig.lib.json examples/di/app.ts
Run deno fmt
for formating your code.
We follow the official Deno style guide
We follow the Conventional Commits
For example
fix(docs): fix typo on DI
Version Info