Make GitHub issue templates a bit more friendly - Githubissues

thoth-station / template-project

This is a Template for any Python based project

GNU General Public License v3.0

7 stars 9 forks source link

Make GitHub issue templates a bit more friendly #29

Closed codificat closed 2 years ago

codificat commented 2 years ago

Related Issues and Dependencies

This introduces a breaking change

No

This Pull Request implements

Some formatting changes to the GitHub templates for bug/feature issue and PR, aiming at improved usability.

Description

I was finding myself editing a bit too much of the templates when creating an issue or PR. This is an attempt to make them more friendly.

Suggestions that are included:

Use markdown structure elements (heading levels, with ##) instead of just bold faces.
Use that structure to nest some of the headings
Put all the guidance text inside HTML comments, so that it does not have to be deleted manually every time
Remove checkbox-based yes/no, as GitHub interprets this as a list of tasks to complete
Some restructure and text changes, especially in the bug report template

sesheta commented 2 years ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: harshad16 To complete the pull request process, please assign goern after the PR has been reviewed. You can assign the PR to them by writing /assign @goern in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/thoth-station/template-project/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment