Rework issue templates to better match our usecase #16

New Issue

2026-03-25T18:40:17+01:00

lars.winzer commented

2026-03-25 18:40:17 +01:00

(Migrated from git.scicore.unibas.ch)

After using the templates (added in https://git.scicore.unibas.ch/cs108-fs26/Gruppe-13/-/issues/7) for a while, I now have a better understanding of the required fields.

Current Situation

The first observation is that having separate templates for each category (bug report, feature request, task, and protocol change) for both the server and client is excessive.

Moving forward, I intend for my other team members to adopt this structure. The reasons for this are as follows:

Tracking the pending tasks, their execution by the individuals involved, and the current progress.
Capturing the thought process, which will be beneficial when refactoring the source code in the future and potentially avoiding previously made mistakes.

Additionally, unlike GitHub, GitLab uses the name of the template itself to determine the name displayed in the dropdown menu.

Pending changes

Moving forward, there should only be a handful of issue templates. No more templates tailored to either the client or server.

As a general rule: Avoid modifying code written and maintained by other team members. Instead, create an issue or task and assign it to them.

Template Name	Use case	Sections	Main label
Bug Report	Reporting a bug found (or presumed) in other peoples code.	Summary, Expected Behaviour, Actual Behaviour, Steps to reproduce, Stack Trace / Error Messages, Possible cause	~bug
Feature Request / Enhancement	Requesting the enhancement or expansion of existing functionalities	Summary, Required workarround (if any), Description of the feature to be added	~enhancement
Task	Used in the early stages of developing new functions or components, without extending or improving existing ones	Summary, Context, Current progress ( as checklist)	~task

For each of the three templates, the following labels can be assigned: ~client, ~server, ~network, ~game-engine, ~documentation, ~ci, ~linting. These labels should be used to provide additional context and quickly find issues or tasks.

To further standardize the structure, templates for merge requests and replies might be added in the future.

After using the templates (added in https://git.scicore.unibas.ch/cs108-fs26/Gruppe-13/-/issues/7) for a while, I now have a better understanding of the required fields. ### Current Situation The first observation is that having separate templates for each category (bug report, feature request, task, and protocol change) for both the server and client is excessive. Moving forward, I intend for my other team members to adopt this structure. The reasons for this are as follows: 1. Tracking the pending tasks, their execution by the individuals involved, and the current progress. 2. Capturing the thought process, which will be beneficial when refactoring the source code in the future and potentially avoiding previously made mistakes. Additionally, unlike GitHub, GitLab uses the name of the template itself to determine the name displayed in the dropdown menu. ### Pending changes Moving forward, there should only be a handful of issue templates. No more templates tailored to either the client or server. As a general rule: Avoid modifying code written and maintained by other team members. Instead, create an issue or task and assign it to them. | Template Name | Use case | Sections | Main label | |---------------|----------|----------|------------| | Bug Report | Reporting a bug found (or presumed) in other peoples code. | Summary, Expected Behaviour, Actual Behaviour, Steps to reproduce, Stack Trace / Error Messages, Possible cause | ~bug | | Feature Request / Enhancement | Requesting the enhancement or expansion of existing functionalities | Summary, Required workarround (if any), Description of the feature to be added | ~enhancement | | Task | Used in the early stages of developing new functions or components, without extending or improving existing ones | Summary, Context, Current progress ( as checklist) | ~task | For each of the three templates, the following labels can be assigned: ~client, ~server, ~network, ~game-engine, ~documentation, ~ci, ~linting. These labels should be used to provide additional context and quickly find issues or tasks. To further standardize the structure, templates for merge requests and replies might be added in the future.

lars.winzer commented

2026-03-26 10:28:30 +01:00

(Migrated from git.scicore.unibas.ch)

mentioned in issue #17

lars.winzer commented

2026-03-26 10:29:04 +01:00

(Migrated from git.scicore.unibas.ch)

marked this issue as related to #17

lars.winzer commented

2026-03-26 12:16:01 +01:00

(Migrated from git.scicore.unibas.ch)

assigned to @lars.winzer

lars.winzer commented

2026-03-26 12:17:08 +01:00

(Migrated from git.scicore.unibas.ch)

created branch feat/16-rework-issue-templates-to-better-match-our-usecase to address this issue

created branch [`feat/16-rework-issue-templates-to-better-match-our-usecase`](/cs108-fs26/Gruppe-13/-/compare/main...feat%2F16-rework-issue-templates-to-better-match-our-usecase) to address this issue

lars.winzer commented

2026-03-26 13:01:42 +01:00

(Migrated from git.scicore.unibas.ch)

mentioned in merge request !47