Skip to content

🧭 Pull Request Review Guide ​

This document defines the conventions to fllow when reviewing your PR befor posting it. The goal is to ensure consistency and prevent mistakes.

Core values:
Consistency, Maintainability, Collaboration, Quality

The goal of every review is to ensure the project remains clean, consistent, well-documented, and easy to maintain over time.


✅ PR Review Checklist ​

1. Git and GitHub ​

  • Steps to prepare and submit your PR:
    • Make sure you are on the correct branch.
    • Commit all changes following the commit conventions (commits should be grouped by functionality and be reversible).
    • The PR must be based on the Development branch.
    • While reviewing your PR, keep it saved as a draft.
    • Request reviwer and assign yourself.
    • Once ready, change the PR status to Ready for Review.

2. Code Conventions ​

  • Ensure all changes follow the existing code conventions, such as:
    • Verify proper component naming.
    • Check spacing between sibling elements.
    • Ensure attributes are in the correct order.
    • Verify import order for dependencies.
    • Ensure constants, attributes, and similar groups are sorted.
    • Check the feature implementation order.
    • Ensure all methods follow the ES5 syntax standard.