🎉 First off, thanks for taking the time to contribute! 🎉
The following is a set of guidelines for contributing to this repository. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [INSERT EMAIL].
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating a bug report, please check the issue tracker to see if the issue has already been reported.
- Use a clear and descriptive title for the issue.
- Describe the steps to reproduce the problem.
- Explain the behavior you expected to see.
- Describe the behavior you actually saw.
- Include any relevant logs or screenshots.
This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.
- Use a clear and descriptive title for the issue.
- Provide a detailed description of the enhancement.
- Explain why this enhancement would be useful.
- Include any relevant examples or mockups.
The process described here has several goals:
- Maintain the quality of the codebase.
- Fix problems that are important to users.
- Engage the community in working together.
- Fork the repository.
- Create a new branch:
git checkout -b feature-name. - Make your changes.
- Test your changes.
- Commit your changes:
git commit -m 'Add feature-name'. - Push to the branch:
git push origin feature-name. - Open a pull request.
Note: Be sure to merge the latest from "main" before making a pull request.
To get started with the project, follow the steps mentioned in README.