Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 2.02 KB
Raw

How to Contribute

Thank you for your interest in contributing to the project! We welcome third-party code contributions via GitHub pull requests. Before you begin, please familiarize yourself with the GNU General Public License v3.0 as all contributions are subject to this license.

Issue Discussion

If you have an idea for an enhancement or want to report a bug, please create a new issue on the GitHub issues page. This is a great place to discuss and get feedback on your proposed changes before starting to work on them.

Branching Policy

To propose a patch or a new feature, follow these steps:

  1. Clone the content from the main branch of the repository.

  2. Create a new branch with a descriptive name, following this format:

    feature/<name_of_the_feature_or_patch_that_you_are_introducing>

    For example: feature/add-new-feature or feature/fix-bug-issue.

  3. Implement your changes in this new branch.

  4. Make sure to maintain consistent code style, using 4 spaces for indentation.

  5. Commit your changes and push the branch to your forked repository.

  6. Open a pull request (PR) to the main branch of the repository.

Code Review

Your pull request will undergo a thorough code review by the project maintainers. Be prepared to make necessary adjustments based on the feedback received. This process ensures the code's quality and adherence to project standards.

Project Standards

To maintain a consistent codebase, please follow these standards:

  1. Every example/source file must include a reference to the LICENSE file.
  2. Use 4 spaces for indentation throughout the codebase.

By adhering to these guidelines, you help us maintain a high-quality and collaborative development environment.

We appreciate your contribution to the project and look forward to reviewing your pull requests. Happy coding!