Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (23 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 1.77 KB

Contributing Guidelines

Thank you for your interest in contributing to our open-source project! We appreciate your willingness to improve our codebase. Please review the following guidelines to ensure a smooth contribution process.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please familiarize yourself with its contents before contributing.

How to Contribute

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Implement your changes following the project's coding standards and guidelines.
  5. Commit your changes with clear and descriptive messages, following the Conventional Commits specification.
  6. Push your changes to your fork.
  7. Submit a pull request (PR) to the main repository's main branch, detailing the changes made and their significance.
  8. Await review from the maintainers. Be patient, as reviews may take time.
  9. Upon approval, your contribution will be merged into the main repository.

Reporting Issues

If you encounter any issues, please report them by creating an issue on GitHub. Provide detailed information, including steps to reproduce and your environment setup.

Help and Support

For assistance or questions regarding the project or contributing process, utilize GitHub Discussions or open an issue.

Code Style and Guidelines

Adhere to the project's existing code style and conventions. Refer to documentation or seek clarification if necessary.

License

By contributing, you agree to license your contributions under the project's LICENSE.

Thank you for your contributions to our project. We value your efforts in enhancing its functionality and quality.