bounswe / bounswe2024group11

Developing Turquiz, a platform for Turkish people to get better at English
https://bounswe.github.io/bounswe2024group11/
11 stars 1 forks source link

Modify Issue Templates #475

Closed meminciftci closed 1 week ago

meminciftci commented 3 weeks ago

🧱 Description

Issue templates should be modified so that a standard way of creating an issue is more clear. Templates should contain an example title format and an example sentence for each part (Description and Acceptance Criteria). Description should contain modals like should, shall, or must and it should be in passive format if possible. Acceptance Criteria should be in imperative format.

To be reviewed by: @Meminseeker

📋 Acceptance Criteria

meminciftci commented 3 weeks ago

Simple todo template and feature request template have been updated.

Meminseeker commented 2 weeks ago

We have some diverged ideas on our issue template. We can continue with the suggestions of @umitcan07

meminciftci commented 2 weeks ago

Current template looks very clean. However, there are no guidance. Sometimes it can be very helpful to see example sentences to create an issue. I suggest we add one example sentence for each of these parts:

  1. Title
  2. Description
  3. Acceptance criteria

@umitcan07 @Meminseeker

meminciftci commented 1 week ago

This issue is no more relevant to the current state. So I am closing it.