Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 3.48 KB

CONTRIBUTION_GUIDE.md

File metadata and controls

79 lines (49 loc) · 3.48 KB
Raw

Contribution Guide

Thank you for considering contributing to our open-source project! We welcome contributions from everyone, and we appreciate your efforts to help improve our project. This guide outlines the process for contributing to our project and provides some guidelines to ensure that your contributions are valuable and align with our goals.

If you are a new contributor, please read this guide to learn more about how to contribute to our project. You may also be interested in picking up one of our good first issues.

How to Contribute

  1. Fork the Repository: Start by forking our repository on GitHub. This will create a copy of the project in your GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using Git.

    git clone https://github.com/<YourGitHub>/sdk.git

  3. Create a Branch: Create a new branch for your contributions.

    git checkout -b my-contribution

  4. Make Changes: Make your desired changes to the codebase. Ensure that your changes adhere to our coding standards and guidelines (run tests, lint code, etc.).

  5. Test Your Changes: Test your changes thoroughly to ensure that they work as expected and do not introduce any regressions.

  6. Commit Your Changes: Commit your changes with a descriptive commit message.

    git commit -m "Add feature X"

    Use the present tense ("Add feature" not "Added feature") and include a descriptive message explaining what your commit does.

  7. Push Your Changes: Push your changes to your forked repository.

    git push origin my-contribution

  8. Submit a Pull Request: Once you have pushed your changes, submit a pull request to the main repository. Provide a clear description of your changes and any relevant context.

  9. Review and Feedback: Your pull request will be reviewed by our team. We may provide feedback or request further changes before merging your contribution.

  10. Merge: Once your pull request has been approved, it will be merged into the main repository.

Guidelines

  • Code Style: Follow our coding style and conventions. If in doubt, refer to our existing codebase for guidance.

  • Documentation: Ensure that your contributions are well-documented. This includes code comments, README updates, and any relevant documentation files.

  • Testing: Write tests for your code to ensure its correctness and maintainability.

  • Compatibility: Ensure that your changes are compatible with the existing codebase and do not introduce any compatibility issues.

  • Respectful Communication: Be respectful and constructive in all communications, including discussions on GitHub issues and pull requests.

  • Licensing: By contributing to our project, you agree to license your contributions under the same license as the project.

Code of Conduct

We adhere to a code of conduct to ensure a welcoming and inclusive environment for all contributors. Please review our Code of Conduct before contributing.

Getting Help

If you need any help or have any questions about contributing to our project, feel free to reach out to us via GitHub issues or email.

Acknowledgements

We appreciate your contributions to our project and value the time and effort you invest in improving it. All contributors will be acknowledged and credited for their contributions.