Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

47 lines (27 loc) · 1.03 KB

Contributing

If you're thinking of contributing, thank you 🎉


Environment

You will need these tools installed on your system:


Developing

Fork this project, download your forked repository locally and create a new branch from main.
Then running npm ci to install the dependecies from package-lock.json.


Testing

The tests are dynamic and can be easily run by performing:

USER='root' PASS='root' npm run tests
  • You can also set a custom HOST and PORT

To clean up the container and files from tests, perform:

npm run tests:reset

Issues and Pull Requests

By opening an Issue or submit a Pull Request, describe your problem or solution. If you can share a basic repro, it will be great.

If you added a feature, make sure you enabled it in ./src/tests/mount.ts.

Naturally, please be respectful 🙋🏻‍♂️