Skip to main content

Working on a single-repo feature

This is a step-by-step guide on how to work with a smaller feature (changes only in a single repository, hot-fix, version bump, small config change, etc.). We will not go into many details on how to work with GitLab; please refer to the GitLab documentation if you need more help. Please see also the General Information document for more information.

1. Create an issue in GitLab​

  • Select the project you'll work in and create an issue there.
  • Set yourself as an assignee.
  • Set at least two labels: category and status (probably In Progress).
  • Estimate issue complexity and weight (weight 1 ~ 2 hours of work, ...).

2. Create a branch for this issue​

The easiest way is to create a branch while you are still in the GUI, right after you've created an issue.

  • Click on Create merge request -> select Create branch -> Click on Create branch.
note

Please always use branch names starting with the issue number. If you are using the method described above, GitLab will do it for you.

3. Work on the issue​

  • Follow the guidelines while working on the issue.
  • Make sure to update any related documentation as well.
  • Make sure all tests pass.

4. Create a Merge Request​

  • Create an MR for it and assign a reviewer. Before clicking on create, please review the code changes and make sure everything looks okay.
  • Move the issue to the To review column.
note

For a smaller issue that does not potentially impact our users, or for a hot-fix that requires immediate action, it might be okay to self-approve the MR. Use your better judgment, and if in doubt, always assign a reviewer.

5. Closing the issue​

  • After the MR is approved, merge the branch.
  • Make sure the branch is deleted after the merge (especially if you unchecked the checkbox to do that automatically).