Skip to content

Latest commit

 

History

History
38 lines (19 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

38 lines (19 loc) · 1.67 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing! This file contains important rules to follow when contributing.

Rules to Follow

  • Lint before you push: Please ensure that the code is linted using ESLint to ensure uniformity.

  • Make good commit messages: Please ensure that your commit messages are short, clear, and explain the what and why of your changes.

  • Follow TypeScript rules: The entire project is written in TypeScript, so please do not add any .js files or ignore TypeScript warnings using // @ts-ignore. Please ensure that everything is properly type hinted.

  • Naming conventions: Variables, files, and components follow specific naming conventions in the repository. Please ensure that you follow these conventions and do not mix them.

  • Include a description: When submitting a pull request, please include a description of the changes you have made and the reason for them. This will make it easier for us to review and merge your changes.

How to Contribute

To contribute to the project, please follow these steps:

  1. Fork the project on GitHub.

  2. Clone your forked repository to your local machine.

  3. Create a new branch for your changes.

  4. Make your changes and commit them with clear and concise commit messages.

  5. Push your changes to your forked repository.

  6. Open a pull request from your forked repository to the original repository.

We welcome all contributions and appreciate your time and effort in helping make this project better. Thank you for your help!

License

This project is licensed under the GPL-3 License. By contributing to this project, you agree to release your contributions under this license.