Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 2.81 KB

Contributing to QUIC-TEEC

Thank you for your interest in contributing to the QUIC-TEEC project! Your support is essential for keeping this project great and for making it better.

Branching Strategy

In general, contributors should develop on branches based off of main and pull requests should be made against main.

Contribution Checklist

Before raising a pull-request, please read and follow this checklist:

  • It's a good idea to arrange a discussion with other developers to ensure there is consensus on large features, architecture changes, and other core code changes. PR reviews will go much faster when there are no surprises.
  • Ensure that you follow the Coding Style Guide.
  • Keep your change as focused as possible. Each commit should represent a logically separate change. If you want to make multiple independent changes, please consider submitting them as separate pull requests. In the description, provide context about what the changes do and why they should be made.
  • Write a good commit message.
  • For every new feature, add Unit Tests to the qcomtee_client or write your own.

Submitting a pull request

  1. Please read our Code of Conduct and License before contributing.

  2. Fork and clone the repository.

    git clone https://github.com/quic/quic-teec.git

  3. Create a new branch based on main:

    git checkout -b <my-branch-name> main

  4. Create an upstream remote to make it easier to keep your branches up-to-date:

    git remote add upstream https://github.com/quic/quic-teec.git

  5. Make your changes and ensuring you follow the Coding Style Guide.

  6. Add Unit tests to qcomtee_client, or write your own. Make sure the old and new tests pass.

  7. Commit your changes using the DCO. You can attest to the DCO by commiting with the -s or --signoff options or manually adding the "Signed-off-by":

    git commit -s -m "Really useful commit message"`

  8. After committing your changes on the topic branch, sync it with the upstream branch:

    git pull --rebase upstream main

  9. Push to your fork.

    git push -u origin <my-branch-name>

    The -u is shorthand for --set-upstream. This will set up the tracking reference so subsequent runs of git push or git pull can omit the remote and branch.

  10. Submit a pull request from your branch to main.

  11. Pat yourself on the back and wait for your pull request to be reviewed.

  12. Participate in the code review to catch issues early and ensure quality.