Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (24 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 1.37 KB
Raw

Contribution Guide

We welcome contributions from the community! To ensure a smooth collaboration process, please follow these steps.

Before You Start

Before making any change, please discuss it on the Github issues. In this way, no other developer will work on the same issue and your PR will have a better chance to be accepted.

Bug Fixes & Enhancements

You may want to fix a known bug or work on a planned enhancement. See the issue list on Github.

Feature Requests

If you have a feature idea for the framework or modules, create an issue on Github or attend to an existing discussion. Then you can implement it if it's embraced by the community.

Code Contribution

  1. Fork the Repository: Create your own copy of the repository by clicking the "Fork" button.

  2. Create a Feature Branch:

    git checkout -b feature/your-feature-name

  3. Make Your Changes: Implement your feature or fix, ensuring your code adheres to the project's coding standards.

  4. Commit Your Changes: Write a clear and concise commit message:

    git commit -m 'Add feature: your-feature-name'

  5. Push to Your Fork:

    git push origin feature/your-feature-name

  6. Open a Pull Request: Navigate to the original repository and submit a pull request. Provide a detailed description of your changes and link any relevant issues.