Thank you for showing interest in contributing to Slax! We want to make it as easy as possible for you to contribute to the project wether it be:
This project is using the conventional commits standard. Please follow these steps to ensure your commit messages are standardized.
Before you can contribute code to the project you need to be able to setup a proper development environment to test the code you just wrote.
It is recommended that you are using Node 19 as your runtime environment.
Our backend relies on MongoDB in order to persist data, it's recommended to use MongoDB Compass in order to view and manage data on your local server.
- Fork the repository and add your branch. (usually
%username%/%patch-type%orpatch-%number of prs%) - Make sure the code you just wrote is properly tested and all features in the service still work properly from the code you changed.
- Ensure you properly describe your pull request.
When reporting a issue to our issue tracker make sure to be as clear and concise as possible. We need as much information as possible and clear steps to reproduce the issue you had in order to properly fix the bug.
When fixing a bug and there isn't already an issue open on our issue tracker make sure to open one and link your Pull Request to it so we know exactly why you're making the changes you are.
Be as clear as possible while making a fix for a bug explaining how the changes you are making will actually fix the issue at hand.
When making a suggestion for a new feature in the service make sure to explain exactly how the feature you are requesting will benefit the service and what it adds to the project.
If you're making a suggestion for a possible way to improve our codebase make sure to explain how exactly your change may be more viable than our current solution, we're always looking for ways to improve so make sure to let us know.