Skip to content

Latest commit

 

History

History
executable file
·
40 lines (29 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
40 lines (29 loc) · 1.53 KB

Contributing Guidelines

We welcome contributions from the community! Please take a moment to review these guidelines before getting started.

Getting Started

  1. Fork the repository and clone it locally.
  2. Create a new branch for your contribution.
  3. Make your changes and test them thoroughly.
  4. Commit your changes with descriptive commit messages.
  5. Push your branch to your forked repository.
  6. Submit a pull request to the main repository.

Code Style

  • Follow the existing code style and conventions used in the project.
  • Write clear, concise, and self-explanatory code.
  • Comment your code where necessary, especially in complex sections.

Issue Reporting

  • Before submitting a new issue, search for existing issues to avoid duplicates.
  • Clearly describe the problem, including steps to reproduce it.
  • Provide any relevant error messages or log output.
  • Include the version of the project you are using.

Pull Request Guidelines

  • Provide a clear and descriptive title for your pull request.
  • Include a summary of the changes made and the problem it solves.
  • Reference any related issues in your pull request description.
  • Make sure your code builds and passes all tests.
  • Keep your pull request focused on a single topic or feature.

Community Guidelines

  • Be respectful and considerate towards others in all interactions.
  • Help create a welcoming and inclusive environment for everyone.
  • Encourage and support fellow contributors with constructive feedback.
  • Avoid engaging in personal attacks or offensive behavior.