Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.55 KB

Contribution Guidelines

We welcome contributions from the community! To help us maintain a high-quality project, please follow these guidelines when contributing:

How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of this repository page to create a copy in your own GitHub account.
  2. Create a New Branch: Create a new branch from main for your changes. Use a descriptive name for your branch.
  3. Make Your Changes: Implement your changes in the new branch. Ensure your code follows the project’s coding style and conventions.
  4. Write Tests: If applicable, write tests to cover the new or changed functionality.
  5. Update Documentation: Update relevant documentation (e.g., README.md) if your changes affect the usage or setup of the project.
  6. Open a Pull Request: Submit a pull request from your branch to the main repository. Provide a clear description of your changes and why they are needed. Link any relevant issues or discussions.

Code of Conduct

Please adhere to our Code of Conduct when participating in the project.

Review Process

  • Review: All pull requests will be reviewed by project maintainers. We may ask for additional changes or clarifications.
  • Merging: Once your pull request is approved and passes all tests, it will be merged into the main branch.

Issues and Bugs

If you find a bug or have a feature request, please open an issue in the repository. Provide as much detail as possible to help us understand and address the issue.