Skip to main content

Code Review Workflow

Athlete Wearable Sensor Workflow

Flow​

This document outlines the code review workflow designed to enhance the collaboration, quality, and efficiency of the development process for the ‘Athlete Wearable Sensor’ project. By integrating GitHub and Trello, we aim to streamline code submissions, reviews, and tracking of changes.

1. Task assignment​

Trello Board​

  1. Tasks are listed on the Trello board under "Product Backlog’ and moved to ‘Sprint Backlog’ during sprint planning.

  2. Developers pick tasks from ‘Sprint Backlog’ and move them to ‘In Progress.

2. Development and Pull request​

Branch creation​

  1. Before starting work, synchronize your local main branch
  2. Create and switch to a new feature branch

Development​

  1. Developers work on their tasks, develop feature or fix according to the requirements.
  2. Commit changes

Push changes and create Pull requests​

  1. Push the feature/fix branch to Github
  2. Create a PR against the main branch and link it to Trello board’ corresponding card.

3. Review process​

Moving to Code Review list​

  1. Developers move the Trello card to “Code review’ list and assign the PR to a reviewer.

Review process​

  1. Reviewers evaluate the PR based on the project's code review guidelines.
  2. Reviewers leave comments, suggest changes, or approve the PR.

Code Review Guidelines​

  1. Clarity: Code should be clear and understandable.
  2. Consistency: Follow the projects coding standards.
  3. Efficiency: Code should be optimized for performance.
  4. Testing: Changes should include unit or integration tests, as appropriate.

4. Implementing feedback/Approval​

  1. The developer addresses the feedback, making necessary revisions. The process repeats until all reviewers approve the PR.
  2. Once approved, the PR is merged into the main branch.
  3. The Trello card is moved to Done.

5. Monitoring and Continuous Improvement​

Process Evaluation:​

  1. Regularly review the efficiency and effectiveness of the code review process.
  2. Make use of feedback from the team and make adjustments to the workflow, guidelines, and tool integrations as necessary to continuously improve the development process.

Workflow Diagram​

Workflow