client
client copied to clipboard
Use issue forms and introduce PR templates
Currently, this repository (as well as a few other repositories within this organization) uses GitHub's issue templates feature to guide the user while creating issues. However, as those templates are merely just a commented Markdown string, less technically adept users may have difficulties filling those out, since the comment syntax may not be violated to not interfere with the rendering.
GitHub provides a new feature called issue forms. The user is presented an actual form which is better structured and easier to use, since fields can have regex-based syntax checks, may be required or optional, may have placeholders, and a lot of other features. One noteworthy feature is requiring the user to check one or more checkboxes, requiring them to accept contribution guidelines or other rules of a repository (for instance, a checkbox "if you do not fill out the form properly, your issue will be closed" can be realized that way, which hopefully makes users add all the required details).
Using forms should lead to more manageable, more complete, i.e., better issues.
The feature is in beta phase, but seems to be stable and is used by many projects already.
We do not make use of PR forms yet, so this issue is just half-finished.
I experimented a bit, but it turned out forms are not supported for pull requests. We can, however, create one or more Markdown templates (similar to the existing Markdown issue template), and I think that would make sense. We should collect some ideas on templates we want to maintain. Some ideas:
- UI change (the template would ask for screenshots)
- Non-UI code change
- Tests-only change (template adds related tags and a prefix to the title)
- CI/build system/packaging change
2-5 types would be acceptable in my opinion.
This issue was marked stale because it has been open for 30 days with no activity. Remove the stale label or comment or this will be closed in 7 days.
This issue was marked stale because it has been open for 30 days with no activity. Remove the stale label or comment or this will be closed in 7 days.
The issue was marked as stale for 7 days and closed automatically.
This issue was marked stale because it has been open for 30 days with no activity. Remove the stale label or comment or this will be closed in 7 days.
This issue was marked stale because it has been open for 30 days with no activity. Remove the stale label or comment or this will be closed in 7 days.
This issue was marked stale because it has been open for 30 days with no activity. Remove the stale label or comment or this will be closed in 7 days.
This issue was marked stale because it has been open for 30 days with no activity. Remove the stale label or comment or this will be closed in 7 days.
This issue was marked stale because it has been open for 30 days with no activity. Remove the stale label or comment or this will be closed in 7 days.
The issue was marked as stale for 7 days and closed automatically.