Contribution Guidelines

General Guidelines

• Respectful Communication: Always be respectful and constructive in your interactions. Refer to the project’s Code of Conduct for guidance on maintaining a positive environment.
• Use Tags: Always use the appropriate tags (bug, enhancement, question) to help categorize your issue and make it easier for maintainers to address.
• Provide Relevant Details: Whether reporting a bug, suggesting a feature, or asking a question, include all necessary context to facilitate understanding and resolution.
• Collaborate: Engage in discussions within the issue thread to refine your contribution and explore solutions collaboratively.

By following these guidelines, you help ensure a productive and welcoming environment for all contributors. Thank you for supporting the project!

Pull Request

When submitting a pull request:

1. Use the Template: Always follow the provided pull request template to ensure that all relevant details are included. Pull requests that do not adhere to the template may be closed without review.

2. Be Clear and Concise: Clearly describe the purpose of your pull request, the problem it addresses, and the proposed solution. Include relevant details such as screenshots, logs, or examples if applicable.

3. Use Tags: Use appropriate tags to categorize your pull request:

   • enhancement for new features or enhancements.
   • bug for bug reports with a proposed fix.

4. Be Patient: Project maintainers will review your pull request as soon as possible. Review times may vary, so please be patient and avoid repeated follow-ups within a short time frame.

5. Collaborate: Be open to feedback and willing to make changes. The maintainers or community may request updates to align your contribution with the project’s standards.

Reporting Bugs

To report a bug:

1. Open an Issue: Use the bug tag to categorize your issue. Include as much detail as possible:

   • A clear and concise title summarizing the issue.
   • Steps to reproduce the problem.
   • The expected behavior versus the observed behavior.
   • Relevant logs, screenshots, or code snippets.

2. Engage with Feedback: Be prepared to answer questions or provide additional details if requested by maintainers or community members.

Proposing New Features

To suggest a new feature or enhancement:

1. Open an Issue: Use the enhancement tag to categorize your suggestion. Include:

   • A clear and concise title summarizing your feature request.
   • A description of the problem the feature will solve or the improvement it will bring.
   • Any relevant mockups, examples, or references that explain your idea.

2. Explain the Impact: Clearly articulate how the feature will benefit the project and its users.

3. Be Open to Discussion: Engage with feedback from maintainers or other contributors, as they may propose alternative solutions or request additional clarification.

Asking Questions

If you have a question about the project:

1. Open an Issue: Use the question tag to categorize your query. Provide enough context to help others understand your question.

2. Be Specific: Clearly state what you need help with or what you are trying to understand.

3. Check Existing Resources: Before opening a question, review the project’s documentation and existing issues to ensure your question hasn’t already been answered.

4. Be Patient: Responses may take time, depending on the availability of maintainers and contributors.