Skip to content

Creating Pull Requests

RevanchistX edited this page Mar 26, 2024 · 4 revisions

Creating Pull Requests

Creating clear and detailed PRs is essential for efficient review and collaboration. Here are our guidelines:

Workflow

  1. feature/* -> release/*
  2. release/* -> development
  3. development -> main

Description

  • Provide a detailed description of the changes, including the 'why' and 'how'.
  • Include screenshots or GIFs for UI changes.

Linking Issues

  • Always link your PR to the corresponding issue(s) to provide context and track progress.

Tagging Reviewers

  • Assign yourself as the Reviewee.
  • Tag the mentors to review your changes, considering FE or BE mentors.

Additional info

  • The PRs aim to improve the code and find and prevent vulnerabilities (security issues, possible bugs) that can cost a lot in the future if not taken care of right away.