Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.39 KB

contribution.md

File metadata and controls

52 lines (36 loc) · 2.39 KB

Contribution Guide

Types of Contributions

We value all kinds of contributions, including:

  • Bug Reports: Help us identify and resolve issues by submitting detailed bug reports.
  • Feature Requests: Suggest new features or improvements to enhance the project.
  • Code Contributions: Submit code changes via pull requests to fix bugs or implement new features.
  • Documentation: Improve the project's documentation to help others understand and use it better.
  • Translations: Contribute translations to make the project more accessible to a wider audience.
  • Community Engagement: Participate in discussions, help answer questions, and provide support to others.

Getting Started

  • Fork the repository and clone it locally.
  • Create a new branch for your contribution: git checkout -b your-branch-name.
  • Make your changes and test thoroughly.
  • Commit your changes with a descriptive commit message: git commit -m "Your message here".
  • Push your changes to your fork: git push origin your-branch-name.
  • Open a pull request against the main branch of this repository.

Code Style and Guidelines

  • Follow the existing code style and naming conventions.
  • Write clear and concise code and comments to enhance readability.
  • Ensure your code is well-tested, especially for bug fixes and new features.

Pull Request Guidelines

  • Provide a clear title and description for your pull request, explaining the purpose of your changes.
  • Reference any related issues or pull requests in your description (e.g., "Fixes #123").
  • Include screenshots or GIFs if your change affects the visual appearance.
  • Ensure all tests pass successfully.
  • Keep your pull request focused. If you're addressing multiple issues or features, consider submitting separate pull requests.
  • Be responsive to feedback and requests for changes during the review process.

Review Process

All contributions will be reviewed by the maintainers of the project. Feedback or suggestions for improvement may be provided. Once everything is approved, your contribution will be merged.

Code of Conduct

Please read and adhere to our Code of Conduct in all your interactions with the project.

Attribution

A huge thanks to all contributors who help make this project better!

If you're unsure about anything, feel free to ask for clarification. We appreciate your efforts to make our project better and look forward to your contributions!