Git & GitHub

On the Arc Onboarding team, we use GitHub to store all client repositories under the wapopartners organization. Repos in this organization are private and require permission to read and/or write code to them.

Depending on the state or type of a project, some repositories are managed by client engineers, not Arc engineers. For example, some Arc clients depend entirely upon their in-house engineers to create the site code; other projects are in a stable state and management of these code bases has been handed off to respective client teams. When committing to a repo, please follow the conventions and processes of the team currently managing the repo.

Submitting PRs

Most of our projects have implemented CI/CD through Circle, and all projects require at least one code review on every PR. In order to merge a PR into any branch, the code must pass CI/CD and be "approved" via code review.

Freshly submitted PRs should include the following details:

  • An explanation of the issue
  • An explanation of what you did to fix it
  • A link to the relevant Jira ticket(s) and/or design documents
  • Steps to reproduce the issue (if relevant)
  • Steps to set up the branch for the reviewer to test locally
  • Screenshots (if relevant)
  • Any other relevant comments/notes for the reviewer

Is this a lot to ask? Yes, it is! But we strongly believe that code reviews help ensure consistency and prevent bugs from arising before we release changes to an client-facing environment.

Code Reviews

Just as we ask every developer to submit his/her work for review, we also share the responsibilities of reviewing each other's code over the course of a project. The code reviewer is responsible for:

  • Recreating the issue on his/her local machine and verifying the the branch in review solves the issue
  • Verifying the fix on multiple browsers and/or screen sizes, where relevant
  • Checking to ensure that the code is commented, clean, and logical
  • Checking to ensure that any relevant documentation has been updated

It is expected that it may take 2-5 rounds of review for a PR is approved and merged.

results matching ""

    No results matching ""