Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 1.56 KB

File metadata and controls

78 lines (47 loc) · 1.56 KB

Contributing

If you're thinking of contributing, thank you, and naturally, please be respectful 🙋🏻‍♂️

Issues

By opening an Issue, please describe the problem.
If you can share a basic repro, it will be great.


Pull Requests

By opening a Pull Request, please describe the proposed solution and what it solves.
The final commit message will be generated from the PR title by using "Squash and Merge".


Developing

⚙️ Environment

You will need these tools installed on your system:


Fork this project, download your forked repository locally and create a new branch from main.
Then run npm ci to clean install the node_modules:

npm ci

Please, do not change the package-lock.json manually.

🔧 Fixes

Where possible, provide an error test case that the fix covers.

❇️ Features

It's better to discuss an API before actually start implementing it. You can open an Issue on Github, so we can discuss the API design implementation ideas.

Please ensure test cases to cover new features.

📘 Documentation

The documentation is held within the main Poku repository.


Testing

👩🏻‍🏭 General

npm test
  • Run the test suite.

👔 Lint

npm run lint

Also

npm run lint:fix
  • Automatically repairs most lint errors.