There are two types of issues we use for development cycle: Bugand Feature. There are other labels for different purposes, however.

Anytime you got stuck or don’t know how something works: remember, that a documentation issue. You need to state that. Task will be reassigned to you. Documentation will be updated shortly. And you will continue to work on it once your new current task will be solved.

See what “To complete an issue” is.

How to complete a Feature

  1. Ask any question you have in the issue comments before starting
  2. Provide a simple write about how you are going to solve this issue, it might help to find wrong directions, and share ideas before writing any code. It might include a simple test to illustrate the desired functionality. Please, pay attention to this, since it may save a lot of time for both us and you
  3. Create a new branch named issue-${ISSUE_NUMBER}
  4. Write some code to complete this task
  5. Write some additional tests to cover edge cases and some possible errors
  6. Write documentation about what have you done and why you have done it this way
  7. Submit a merge request

How to fix a Bug

  1. Ask any question you have in the issue comments before starting
  2. Provide a simple write about how you are going to solve this issue, it might help to find wrong directions, and share ideas before writing any code. It might include a simple test to illustrate the desired functionality. Please, pay attention to this, since it may save a lot of time for both us and you
  3. Create a new branch named issue-${ISSUE_NUMBER}
  4. Write a test that is failing to validate that this bug exists
    1. If you can not recreate this bug, feel free to submit just a test with clear name and documentation linking to this issue
    2. If a test fails indeed, continue to the next step
  5. Now, when you have a regression test ready - create a fix for that bug
  6. Write any additional tests if needed
  7. Write a post-mortem entry about what was wrong
  8. Submit a merge request

Good read about “How to fix a bug”.

Notifications

Correct set of notifications allows users to productively work with asynchronous communication.

Lack or huge amount of notifications ruins the process. Managing them is a required skill for us.

We use /subscribegitlab quick action to subscribe authors of issues and merge-requests to the resource.

However, there are several things to keep in mind:

  1. You should enable email notifications for the project
  2. You can possibly enable pipeline browser notifications
  3. You can subscribe to related issues and merge requests
  4. You can use browser plugins

Do not close issues by hands

You should never close issues by hands. There’s only one way to close an issue: with a merge request. Any issue closed by anyone except the architect will be reopened.