Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (35 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 1.68 KB

Contributing to mini-sandbox

Hi there! We’re thrilled that you’d like to contribute to this project. Your help 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.

Submitting a pull request

  1. Fork and clone the repository.

    git clone https://github.com/<username>/mini-sandbox.git

  2. Create a new branch based on main:

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

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

    git remote add upstream https://github.com/qualcomm/mini-sandbox.git

  4. Make your changes, add tests, and make sure the tests still pass.

  5. 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"`

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

    git pull --rebase upstream main

  7. 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.

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

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