🍪 Note: Our web-capstone-docs subdomain is a cookie-free zone.
Development

Feature Development

Working on a User Story

Update the GitHub Project Board

  • Move the user story on the board to the ⚙️ In Progress column
  • Max. two user stories (1 per coding pair)

Preparation

  • Switch to the main branch
  • Run git pull to ensure you have the latest changes

Create Feature Branch

  • Create a new branch specifically for the new feature, e.g. feature/entries-list

Feature Development

  • Start coding
  • Make regular, small commits to save your progress
  • Complete the Tasks from the user story
  • Ensure that all Acceptance Criteria from the user story are met
💡

Recommendation: Use Pair Programming and split up your team to work on independent User Stories or independent tasks of a single User Story (e.g. different components).

Pull Requests & Code Reviews

Title and Description of PRs

  • Give the PR a meaningful title that summarizes the essence of the changes/feature
  • Write a clear, but short, description of the PR. This should include:
    • Summary of what has been changed/added
    • Reason for the change/addition
    • Screenshots, if helpful
  • Link to the associated User Story

Share Pull Request for Review

Update the GitHub Project Board

  • Move the user story on the board to the 🔬 Review column

Updates and Continuation

  • Apply feedback from the review to your feature
  • If PR is not approved, implement suggestions and continue developing until the PR is approved
  • If PR is approved. continue to Quality Assurance

Quality Assurance

Post and Describe Changes

Cycle for Required Changes

  • Based on feedback, the developer/team should make any necessary changes
  • Request a re-review after making the changes

Concluding the QA Process

Merge Feature Branch

  • Once the QA is approved, merge the feature branch into main
  • Ensure that no conflicts arise during the merge
  • If conflicts do arise, solve them and request another review

Update the GitHub Project Board

  • Move the user story on the board to the ✨ Done column
  • Close the corresponding PR on GitHub

Cleanup

  • Delete the feature branch, both locally and on GitHub
  • Switch to the main branch and pull the latest changes
  • Ensure everything is in order and works correctly after the merge