Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 3.97 KB

Contributing Guidelines

Thank you for your interest in contributing to our project. Your involvement is truly appreciated, and every effort helps us grow and improve. We invite you to join us on this journey with the same passion and patience as expressed in our guiding words.

Table of Contents

Code of Conduct

We are committed to creating an inclusive and supportive environment. Please review our Code of Conduct to ensure a respectful, constructive, and friendly experience for everyone.

How to Contribute

We welcome contributions in various forms. Whether you're reporting a bug, suggesting a feature, improving documentation, or diving into code, your input makes a difference.

Ways to Contribute

  1. Bug Reports

    • Pros: Helps identify and resolve issues quickly, ensuring a smoother experience for all users.
    • Cons: May require detailed reproduction steps and sometimes, issues can be hard to replicate.

  2. Feature Requests

    • Pros: Drives innovation and evolution of the project by introducing fresh ideas.
    • Cons: Not all feature requests can align with our project goals, so some suggestions might be deferred.

  3. Documentation Improvements

    • Pros: Enhances clarity and usability, benefiting both new and experienced users.
    • Cons: Requires consistency with existing documentation style and thorough review for accuracy.

  4. Code Contributions

    • Pros: Directly impacts the project's functionality and quality.
    • Cons: Must adhere to our coding standards and include adequate testing to ensure reliability.

Reporting Issues

If you encounter a bug or have suggestions for improvement, please follow these steps:

  • Search Existing Issues: Check the issue tracker to avoid duplicates.
  • Create a Detailed Issue: Include a clear description, steps to reproduce the issue, screenshots/logs if applicable, and reference any related issues.
  • Be Patient: Our team reviews every issue with care and may ask for additional details.

Pull Requests

Before submitting a pull request, please ensure you:

  1. Fork the Repository: Create your branch from the latest version of the main branch.
  2. Implement Your Changes: Make sure your code is well-documented, adheres to our style guidelines, and includes tests where necessary.
  3. Write Clear Commit Messages: Your commit messages should be descriptive and reflect the purpose of the changes.
  4. Submit a Detailed Pull Request: Explain the changes you’ve made, reference relevant issues, and provide any context that will help our reviewers.

Our maintainers will review your pull request and may request revisions. We appreciate your cooperation and the time you invest in making our project better.

Style Guidelines

To maintain high quality and consistency:

  • Coding Standards: Follow the project’s coding conventions and best practices.
  • Documentation: Ensure that any changes or additions to the documentation are clear and thorough.
  • Testing: Include or update tests to reflect changes, ensuring that new code does not break existing functionality.
  • Comments: Write meaningful comments to clarify complex logic for future readers.

Acknowledgments

We are deeply grateful for your contributions. Every bug report, suggestion, and line of code enriches our project and community. Your commitment and passion are the keys that help us overcome challenges—just as water gracefully finds its way around obstacles.

Thank you for being a valued member of our community. If you have any questions or need further assistance, please feel free to reach out.

With warmest regards,
Eliyanto Sarage