We welcome contributions to Kalatori! By participating in this project, you agree to abide by the following guidelines.
-
Fork the repository
Fork the repository on GitHub and clone your fork locally:
git clone [email protected]:Vovke/kalatori-daemon-ts.git cd kalatori-daemon-ts
-
Create a branch
Create a new branch for your feature or bugfix:
git checkout -b feature-branch
-
Install dependencies
Ensure you have all necessary dependencies installed:
yarn install
-
Make your changes
Make your changes to the codebase. Ensure your changes adhere to the project's coding standards and pass all tests.
-
Run tests
Run the tests to ensure everything works correctly:
yarn test -
Commit your changes
Commit your changes with a clear and descriptive commit message:
git commit -am 'Add new feature' -
Push to your fork
Push your branch to your forked repository:
git push origin feature-branch
-
Open a Pull Request
Open a pull request on the original repository. Provide a clear description of the changes you have made and why they should be merged.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
If you find a bug or have a feature request, please report it using the GitHub issues page. Ensure your issue includes the following:
- A clear title and description
- Steps to reproduce the issue (if applicable)
- Any relevant screenshots or logs
- Follow the existing code style.
- Write clear, concise comments where necessary.
- Keep commits small and focused on a single change.
Thank you for your contributions!
The Alzymologist Team