manual_teachbooks/book/workflows/milestones_issues.md
2024-03-25 09:56:38 +01:00

1.5 KiB

Milestones & Issues

In a repository, team members can define Milestones and Issues. Milestones are used to track the overall progress of the project to make sure that deadlines are met. A milestone can group many issues, which are individual tasks that need to be finished in order to reach the milestone.

An issue is built up of the following attributes:

  • the title, this should just be a quick description of the task
  • a label, to assign a category to the task such as: new content
  • an assignee, the person who created the task can assign a team-member to the task or the task can remain without an assignee. Then whoever would like to pick up the task can assign it to themselves!
  • a discussion section, here team-members can discuss any questions about the task
  • a due date, in case the task is urgent or to keep track of deadlines

Every team member can create issues when they think of a task that would improve the book.

````{tab-item} Issues in GitLab

The issues in GitLab can be found on this page:

<img src="figures/Issues.png" alt="New Issue" width="1000" style="display:block; margin-left:auto; margin-right:auto;"> <br>

You can create an issue by clicking on the blue `New Issue` button in the top right corner.

<img src="figures/New_Issue_GitLab.png" alt="New Issue" width="600" style="display:block; margin-left:auto; margin-right:auto;"> <br>
````

````{tab-item} Issues in GitHub
...

````

When the task is completed, the issue can be closed and you can move on to the next!