Issues

How to open an Issue?

• Check if your issue is already opened, do not open duplicate issues!
• Write your title clear and concise.
• Write detailed and understandable details in the description.
• Select appropriate assignees, labels, projects, milestones for the issue.

How to Label an Issue?

Platform Labels

• Platform: Documentation This Issue represents to the Documentation parts of the project.
• Platform: Backend The Issue represents to the backend parts of the project.
• Platform: Frontend The Issue represents to the frontend parts of the project.

Priority Labels

• Priority: Critical
• Priority: High
• Priority: Low
• Priority: Medium

NOTE: These are the priority level of issues.

Status Labels

• Status: Abandoned The Issue is not related to anyting about the project or the repository. (e.g. It was opened for misuderstood or etc.)
• Status: Accepted Assignees of the Issue accepted to work on the related issue.
• Status: Blocked The job blocked because of this issue.
• Status: Dublicate Some time another Issue for the purpose of this one has already been opened (and maybe has been closed).
• Status: Help Needed Assignees of the Issue need a help for the Issue.
• Status: Invalid Assignees of the Issue solved it. This is generally shows that the Issue should be closed.
• Status: Review Needed Assignees of the Issue need a review for the Issue.
• Status: Revision Needed Assignees of the Issue need a revision for the Issue.

Type Labels

• Type:Bug There is a bug in the specified part(s) of the project.
• Type:Code Review A code review about the project related part(s).
• Type:Configuration A new feature needs to be (or will be) designed/implemented in the project.
• Type:Costumer Review A question about the project or the repository related part(s).
• Type:Enhancement Some enhancement needs to be (or will be) done to the specified part(s) of the project.
• Type:Maintenance A maintenance about the project or the repository related part(s).
• Type:Meeting A meeting about the project or the repository related part(s).
• Type:Question A question about the project or the repository related part(s).

How to Close an Issue?

• Always close issues by giving an explanation.
• Commenting on future considerations would be an optional good practice.
• Summarizing the resolution of the issue would be an optional good practice.

Additional Resources

GitHub Issues

GitHub Developer Issues

Issue Formatting