ESPROFILER Handbook
Engineering

Contributing

If you're contributing to ESPROFILER, this section provides you with quick links to tools, resources and best practices to help you in your day-to-day role and work seamlessly with the rest of the engineering team.

Branching Practices

TBC

Merge Requests

Merge Requests in GitLab should always contains a description of what has changed and why. Where possible, they should link to an issue/task in Jira that will be closed as a result of the Merge Request being merged.

Reviews

Every review requires at least one approval. As part of your review you need to cover:

  • Admin: Does the MR describe the changes made, and link to the appropriate issue/task in Jira?
  • Tests: Are any appropriate tests added or updated?
  • Docs: Are there any appropriate docs that need updating to reflect the changes made?
  • Performance: Is the code performant and efficient?

Proposing Changes

Comments should be left that describe, in detail, why a MR may not be approved. If changes are requested, be helpful in your feedback to explain what changes are required, ven more helpful, if the changes are quick/minor, use GitLab's "Insert Suggestion" option to provide explicit code changes to the author of the MR.

Approve with SAML

An important element of our review process on GitLab is that each review must be explicitely authenticated. As such you cannot "Approve" via the "Your Review" button in GitLab, you will be met with a warning:

To approve this merge request, please enter your password. This project requires all approvals to be authenticated.

Instead, when approving, you must click the "Approve with SAML" button that appears inline of the issue:

Tools

Platform Ops

Eveyrthing you need to know about observability of ESPROFILER, as well as reporting and handling issues as they arise with infrastructure and hosting.