Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

68 lines (47 loc) · 1.94 KB

Contributing to EdgeX Native Build

Thank you for considering contributing to the EdgeX Native Build project! Here are some guidelines to help you get started.

How to Contribute

  1. Fork the Repository:

    • Click the "Fork" button at the top right of this page to create a copy of this repository in your GitHub account.
  2. Clone Your Fork:

    • Clone your forked repository to your local machine:
      git clone https://github.com/your-username/edgex-native-build.git
      cd edgex-native-build
  3. Create a Branch:

    • Create a new branch for your changes:
      git checkout -b my-feature-branch
  4. Make Changes:

    • Make your changes to the codebase. Ensure your code follows the project's coding standards and passes all tests.
  5. Commit Changes:

    • Commit your changes with a clear and descriptive commit message:
      git add .
      git commit -m "Add feature X"
  6. Push to GitHub:

    • Push your changes to your forked repository:
      git push origin my-feature-branch
  7. Create a Pull Request:

    • Go to the original repository and click the "New Pull Request" button.
    • Select your branch and submit the pull request.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Reporting Issues

If you encounter any issues, please report them by creating a new issue in the Issues section.

Style Guide

  • Follow the existing code style.
  • Write clear, concise comments.
  • Ensure your code is well-documented.

Testing

  • Ensure that your changes pass all existing tests.
  • Add new tests for any new features or bug fixes.

License

By contributing, you agree that your contributions will be licensed under the same license as the project.


Thanks 😊