Contributing

How to contribute to FusionAD

Details of how to help contribute to affordable autonomous driving.

General Reminders

Please keep your issues and pull requests small and manageable so they are easy to track and reduce chances of merge conflicts that are difficult to resolve.

Initial Setup

• Fork the project and clone your fork
  • This may already be done if you have previously worked on an issue
• Set up the original repository as an upstream repository with instructions found here

Preparing to Start Work

• Submit an issue with the relevant enhancement or bug fix
  • Assign the relevant person(s) to work on this task as "Assignees." This is usually yourself
  • Add labels and project if applicable
  • All issues should have a milestone
• To update your copy of test_deployment with upstream follow these instructions
  • Be sure to update your test_deployment branch regularly to keep your fork up-to-date
• Branch off from test_deployment with the naming convention ISS-xx, where "xx" is the issue number
  • EXAMPLE: "ISS-54" corresponds to issue 54
  • NOTE: Always be sure to branch from the latest version of test_deployment (from the original repo) at the time to reduce chances of merge conflicts.

After Your Work Is Done

• When you are finished working on the chosen issue, submit a pull request from your forked branch into the original repo's test_deployment branch, where your code will be tested on the car.
  • Assign relevant reviewers for your pull request
  • The "Assignee" will be the person who merges the pull request. This will usually be yourself
  • Write "Closes #xx" (where "xx" is the issue number you were working on) in your pull request message so the issue will you were working on be automatically closed after the pull request is merged
  • More info can be found here regarding how automatic issue closing works with keywords in GitHub
• Select "Squash and merge" on GitHub to merge your changes, after approval
• Delete the branch after your pull request has been approved and merged
  • A button should appear on GitHub after your successful merge to delete your branch from the pull request web page.