admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-13 23:05:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
manual_teachbooks/book/workflows/milestones_issues.md
Julie Kirsch 9e3c415b59 this is an old commit
2024-04-20 16:16:03 +02:00

2.3 KiB
Raw Blame History

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.

The following tabs explain where the Issues can be found in GitLab and GitHub.

````{tab-item} GitLab

The issues in GitLab can be found in your repositery in the left bar. 

<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. This will lead you to this window where you can specify all attributes we mentioned before!

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

````{tab-item} GitHub

The issues in GitHub can be found in your repositery in the top bar.

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

Clicking on `Issues` will open up the page with all the issues on this repositery.

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

Finally, by clicking the green `New Issue` button you can create a new issue and specify all the attributes we mentioned before!

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

````

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