51 lines (36 loc) · 1.64 KB

Contributing

Thank you for your interest in contributing! Your contributions are valuable and help improve the project.

Getting Started

Fork the Repository: Fork the repository to your own GitHub account.
Clone the Fork: Clone your forked repository to your local machine.
```
git clone https://github.com/your-username/repository-name.git
```
Create a Branch: Create a new branch for your feature or bugfix.
```
git checkout -b feat/your-feature-name
```

Making Changes

Follow the existing code style and conventions.
Write clear and descriptive commit messages following the Conventional Commits guidelines.
Update or add documentation as necessary.

Submitting Changes

Push Changes: Push your branch to your forked repository.
```
git push origin feat/your-feature-name
```
Open a Pull Request: Submit a pull request to the main branch of the original repository.
- Provide a clear title and description.
- Reference any related issues.

Code Review Process

Your pull request will be reviewed by the maintainers.
Be responsive to feedback and make necessary changes.
Once approved, your changes will be merged into the project.

Reporting Issues

Use the issue tracker to report bugs or suggest enhancements.
Provide as much detail as possible.

Community Guidelines

Be respectful and considerate in all interactions.
Follow the project's code of conduct.

License

By contributing, you agree that your contributions will be licensed under the MIT License.