Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

84 lines (60 loc) · 2.11 KB
Raw

Contributing to Unitest

Welcome, and thank you for taking time in contributing to Unitest! You can improve Unitest in different ways:

  • ∆ submit new features
  • ✘ find bugs
  • ✔︎ review code
  • 𝔸 improve our documentation

Development Setup

You will need Deno 1.15+.

  1. Fork this repository to your own GitHub account.
  2. Clone the repository to your local device.
  3. Create a new branch git checkout -b BRANCH_NAME.
  4. Push your branch to Github after all tests passed.
  5. Make a pull request.
  6. Merge to master branch by our maintainers.

Testing

You can run all tests with the following command:

deno test --ignore=node_modules,_docs --import-map=test_import_map.json --doc

Project Structure

  • _docs - documents and document generator
  • _e2e - End to End tests
  • compat - compat module for browser
  • expect - expect module
  • dummy - dummy objects
  • helper - helper for entire module
  • matcher - matcher collections
  • mock - mock object
  • modifier - modifier collections
  • test - test register

Code Style

The code style is based on the Deno Style Guide.

Commit

Commit messages should follow conventional commit. If you are available Node.js, you can use the CLI to commit interactively. (optional)

You can do this with any package manager, but please do not commit the newly generated lock file.

npm i
npm run cz
yarn
yarn cz
pnpm i
pnpm cz

cz-conventional-changelog is invoked to generate commit messages interactively.

The scope should follow Project Structure.

example:

feat(matcher): add new matcher

Code of Conduct

All contributors are expected to follow our Code of Conduct.