Skip to content

Pull Request Rules

Jump to bottom
Mehdi Alaoui edited this page Sep 29, 2024 · 1 revision

Pull Request Rules

Following a clear set of rules for pull requests ensures that our development process is efficient, organized, and easy for everyone to follow. By adhering to these guidelines, we ensure that every team member is on the same page, code reviews are smoother, and our workflow remains seamless. This also helps maintain high code quality and makes it easier to track progress.

Rules for Pull Requests

1. Assigning Reviewers

  • Team Size Matters: Depending on the size of our team, make sure to assign one or two reviewers for each pull request.
    • If the team is small, assign one reviewer.
    • If the team is larger or the changes are substantial, assign two reviewers to ensure a more thorough review.

2. Adding Appropriate Labels

To maintain consistency and clarity in tracking issues and commits, it's important to use the following labels:

Priority Labels

  • prio:low: Use this label for non-urgent issues or changes.
  • prio:high: This label is for critical or time-sensitive issues and changes that need immediate attention.

Subject Labels

At least one subject label must be included with every issue or commit:

  • meta: For changes related to metaprogramming tasks like modifications to build scripts (e.g., build.gradle.kts) or project configurations.
  • feature: When a new feature is being added to the codebase.
  • enhancement: Use this label when an existing feature is being improved or optimized.
  • question: For issues or pull requests where something is unclear and requires further discussion or investigation.
  • bug: This label is used for any fixes addressing a bug or issue with the current functionality.
  • PoC: For "Proof of Concept" changes, use this label when you're submitting experimental code to test out an idea or approach.

3. General Guidelines

  • Every pull request should include at least one priority label and one subject label.
  • Make sure the code is thoroughly tested before submitting the pull request.
  • Ensure the pull request description is clear, detailing the purpose of the changes and any necessary context for the reviewers.

By following these rules, we maintain a streamlined and organized development process that allows for efficient collaboration and high-quality code contributions.

Clone this wiki locally