Thank you for considering contributing to this project! We welcome contributions of all kinds. Please take a moment to review the guidelines below.
-
Fork the Repository
Create a fork of this repository to make your changes. -
Clone Your Fork
Clone your forked repository to your local machine:git clone https://github.com/your-username/your-repository-name.git
-
Create a Branch
Create a new branch for your feature or bug fix:git checkout -b feature-or-bugfix-name
-
Make Changes
Implement your changes and ensure your code adheres to the project's coding standards. -
Test Your Changes
Run tests (if there are any) to ensure your changes work as expected:npm test -
Commit Your Changes
Write clear and concise commit messages:git commit -m "<type>(optional scope): <description>"
Please use semantic commit messages to describe your changes. This helps maintain a clear and structured commit history. The format is as follows:
<type>(optional scope): <description>
[optional body]
Common types include:
feat: A new featurefix: A bug fix or error correction in the codehotfix: A quick and urgent fixdocs: Documentation changesstyle: Code style changes (spaces, formatting, etc.)refactor: Code refactoring without adding features or fixing bugstest: Adding or updating testschore: Maintenance tasks (e.g., updating build scripts)build: Changes to the build system or dependenciesci: Changes to CI configuration or scriptscleanup: Code cleanuplint: Code linting fixesremove: Removal of code, files, or functionalityperf: Performance improvementsrevert: Reverting a previous commit
-
Push Your Changes
Push your branch to your forked repository:git push origin feature-or-bugfix-name
-
Open a Pull Request
Open a pull request to the main repository. Provide a detailed description of your changes.
If you encounter any issues, please report them by opening an issue in the repository. Provide as much detail as possible to help us address the problem.
- Follow the existing code style and conventions.
- Ensure your changes do not introduce new linting errors or warnings.
Thank you for contributing! Seed on!