Development Practices - ncsurobotics/SW8S-ROS GitHub Wiki

Seawolf 8 Ground Rules and Development Practices

Ground Rules

  • Attend weekly meetings if possible, give notice to software lead otherwise
  • Code reviews should consist of positive feedback and constructive criticism only
  • No untested code in the master branch
  • Work on tasks/issues assigned to you, if you want to be retasked bring it up with the software lead
  • If working on a task that has not been assigned/created, create a Github issue and put a note about it in the Slack to keep the team updated

Workflow

  1. Create or be assigned an issue
  2. Create a new branch for that issue and reference it in any commits
  3. Write tests and code pertaining to that issue. If code cannot be unit tested, it must be simulated in Gazebo before being merged
  4. Create pull request to master branch
  5. Get pull request reviewed by at least one other person (review of any code changes, verifying that code is tested and works as expected). If changes are needed, go back to step 3
  6. Merge to master
  7. Close issue when all requirements have been completely met