Skip to main content

Working on a larger feature

This is a step-by-step guide on how to work with a large feature that might span over multiple repositories, require splitting into several issues, 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. Make sure an epic exists in GitLab​

  • For a larger feature, an epic will be created by the project management team.
  • For a smaller feature that requires changes to multiple repos, one can create an epic themselves.

Creating an epic​

  • Create an epic in the NDIP group.
  • Make sure to give a meaningful title and description (ideally, in the form "As a XXX, I want XXX so that XXX").
  • Make sure to add Acceptance Criteria to the description.
  • Set at least two labels: category and status (probably In Progress or Selected for Development).
  • Create a closing issue called Epic review using the issue template epic_review. This "dummy" issue does not have any code (it can belong to any project, e.g., "Platform Documents") and is used to officially close the epic.

2. Create issues for the epic​

  • Create as many issues for this epic as needed.

3. Work on the epic​

4. Closing the epic​

Work with the Epic review as a final step of working on the epic:

  • Make yourself an assignee.
  • Review the checklist and ensure that all items are completed.
  • Add an epic reviewer as the assignee for this issue.
  • Let them confirm that items are completed and approve the issue.
  • Congratulations! Now you can close this issue and close the epic.
note

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