Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

47 lines (25 loc) · 2.77 KB

Contributing Guidelines

Welcome to the project! We're glad you're here and interested in contributing. Before you get started, please take a moment to review the following guidelines to help make the contribution process smooth and effective for everyone.

How to Contribute

Repository Structure

This repository uses a automated version release using the mains 3 branches:

  • master: Contains the code on the actual @latest package channel.
  • beta: Contains the code on the actual @beta package channel.
  • dev: Contains the code of actual development, every BREAKING CHANGE and feat commit must be done on this branch.

Step by Step

  1. Fork the repository: Click on the "Fork" button on the top right corner of the repository's page, then clone your fork locally.

  2. Create a new branch: Make your changes in a new branch created from the dev branch or main for fix or others specific situations. Choose a descriptive name for your branch related to the issue or feature you're working on.

  3. Make your changes: Implement the changes or additions you'd like to contribute. Please follow any existing coding style and conventions.

  4. Test your changes: Ensure that your changes do not break existing functionality. If you're adding new features, include tests to cover your code.

  5. Commit your changes: Make meaningful and atomic commits. Please provide a clear and descriptive commit message for each commit.

  6. Push your changes: Once your changes are ready, push your branch to your fork of the repository.

  7. Create a Pull Request (PR): Go back to the original repository and navigate to the Pull Requests tab. Click on "New Pull Request" and choose your branch as the compare branch. Fill out the PR template with relevant information and details about your changes.

  8. Review and address feedback: Be open to feedback and iterate on your changes if necessary. Respond promptly to any comments or requests for changes from the maintainers.

  9. Merge your PR: Once your PR has been approved and all checks have passed, a maintainer will merge your changes into the respective branch. Congratulations on your contribution!

Code of Conduct

Please note that this project is governed by our Code of Conduct. By participating in this project, you agree to abide by its terms.

Contributor License Agreement (CLA)

By contributing to this project, you agree to license your contributions under the project's license.

Help and Support

If you need any assistance or have questions about contributing, feel free to reach out to the project maintainers or open an issue for discussion.

Thank you for your interest in contributing to the project! 🚀