Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.79 KB

CONTRIBUTION.md

File metadata and controls

43 lines (28 loc) · 1.79 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to our project! We value the contributions of our community and appreciate your help in making our project better.

Commit Message Convention

We follow the Conventional Commits convention for commit messages. This helps us maintain a clear and consistent commit history.

Please ensure that your commit messages adhere to the following format:

<type>(<scope>): <description>

[optional body]

[optional footer]
  • <type>: The type of the commit (e.g., feat, fix, docs, etc.)
  • <scope>: The scope of the commit (e.g., module name, component name, etc.)
  • <description>: A short description of the changes made in the commit
  • [optional body]: Additional information about the commit (e.g., motivation, implementation details, etc.)
  • [optional footer]: Any relevant issue references or breaking changes

Pull Request Guidelines

When submitting a pull request, please follow these guidelines:

  1. Fork the repository and create a new branch for your changes.
  2. Ensure that your code follows our coding style guidelines.
  3. Include tests for the changes you made, if applicable.
  4. Update the documentation, if necessary.
  5. Commit your changes using the Conventional Commits convention.
  6. Push your branch to your forked repository.
  7. Submit a pull request to the main repository.

Code Style Guidelines

We follow a set of code style guidelines to maintain a consistent codebase. Please ensure that your code adheres to these guidelines before submitting a pull request.

Issue Reporting

If you encounter any bugs or issues, please report them using our issue tracker. Provide as much information as possible, including steps to reproduce the issue and any relevant error messages.