l483 / community-standards-template Goto Github PK

Problem/Motivation

There is no issue template for tooling changes to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a tooling template built analogue to the feature request template.

Acceptance Criteria

• add a tooling template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

There is no issue template for dropping features to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a feature drop template built analogue to the feature request template.

Acceptance Criteria

• add a feature drop template built analogue to the feature request template

Further Information

None

Related Issues

None

Object of Interest

The Problem/Motivation section of performance.yml** and performance.md.

Problem/Motivation

The section does not separate the concerns of problem/motivation and reproducibility.

Solution Proposal

Create an optional Reproduction section and remove the concern of reproducibility from the Problem/Motivation section.

Impact

No response

Acceptance Criteria

• performance.yml has a Reproduction section
• The Problem/Motivation section of performance.yml is not concerned with reproducibility
• performance.md has a Reproduction section
• The Problem/Motivation section of performance.md is not concerned with reproducibility

Further Information

No response

Related Issues

No response

Problem/Motivation

There is no issue template for testing changes to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a testing template built analogue to the feature request template.

Acceptance Criteria

• add a testing template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

Security issues should be handled in a more secure way than opening public issues.

Solution Proposal

Delete the security issue template from the classic templates to encourage using GitHub's security advisory or any other method mentioned in a security policy instead, even when using the classic templates.

Impact

No response

Acceptance Criteria

• delete the security issue template

Further Information

No response

Related Issues

• #9

Problem/Motivation

There is no issue template for maintenance to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a maintenance template built analogue to the feature request template.

Acceptance Criteria

• add a maintenance template built analogue to the feature request template

Further Information

None

Related Issues

None

Object of Interest

All summary elements of all details elements of all issue forms.

Problem/Motivation

The collapsed details need a clearer indication of interactivity. Underline their summary to make them appear more similar to clickable links.

Solution Proposal

Wrap an <ins> element around all <b> elements of all <summary> elements. While this is not a good approach of styling elements, it is a functioning workaround. Using <u> failed and styling through CSS gets removed in GitHub's sanitation process.

Impact

No response

Acceptance Criteria

• Add the <ins> as described in all issue forms
• Add the <ins> as described in the meta issue form

Further Information

No response

Related Issues

No response

Problem/Motivation

The "Information for contributors about label usage" section contains instructions that are featured in all issue forms and templates. Later on, they should also be featured in the contributing guidelines. If they ever need an update, updating them everywhere becomes a cumbersome task.

Solution Proposal

Updating this text (excluding the actual text changes) should be a single-step one-minute task. It should also work on all major desktop operating systems without installing an additional application.

Add a script that takes the content of a predefined file and replaces the current "Information for contributors about label usage" in every issue form and template, as well as in the contributing guidelines.

Impact

No response

Acceptance Criteria

• Create a file inside .github that contains the "Information for contributors about label usage"
• Add the possibility to update this information in every issue form and template, as well as in the contributing guidelines with the content of the described file
  • Create a shell script without auto-commit
  • Create a shell script with auto-commit
  • Create a PowerShell script without auto-commit
  • Create a PowerShell script with auto-commit

Further Information

No response

Related Issues

• blocked by #25
• #27

Problem/Motivation

There is no issue template for text corrections to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a text correction template built analogue to the feature request template.

Acceptance Criteria

• add a text correction template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

The project is still missing contributing guidelines to raise the evaluation of GitHub's community standards.
Not only is it needed to check this item on that list, but it also explains in detail the procedures to develop and maintain this project while upholding good quality.

Furthermore, there are currently misplaced and duplicated contributing guidelines at the end of each issue form and template.

Solution Proposal

Create good contributing guidelines in a way that GitHub registers them.

Not only, but also include the label usage instructions (found at the end of issue forms and templates) inside them and remove these instructions from all issue forms and templates.
Include a reference to the contributing guidelines at the start of each issue form and template.

Impact

No response

Acceptance Criteria

• reference the code of conduct
• reference the security policy
• name the following contact options
  • issues
  • security advisories
• explain issue creation conventions
• explain labeling conventions
• explain branching conventions
  • types of branches
    • main branch
    • dev branch
    • hotfix branches
    • issue branches
  • branch naming
  • branch creation
  • branch deletion
• explain commit conventions
• explain pull requests/ merge requests conventions
• explain code conventions
• explain code comment conventions
• explain documentation conventions
• explain testing conventions
• explain development tools and how they are used

Further Information

No response

Related Issues

No response

Problem/Motivation

There is no issue template for documentation changes to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a documentation template built analogue to the feature request template.

Acceptance Criteria

• add a documentation template built analogue to the feature request template

Further Information

None

Related Issues

None

Affected Version

main

System Information

GitHub Webinterface

Bug Behavior

All textareas in all issue forms display text as codeblocks with markdown syntax highlighting.

Expected Behavior

The textareas should display rendered markdown.

Reproduction

1. Open an issue with any issue form
2. Look at the resulting issue

Solution Proposal

Remove every render: markdown line in all textareas of all issue forms.

Impact

No response

Acceptance Criteria

• remove every render: markdown line in all textareas of all issue forms.

Further Information

GitHub's documentation on the render part of textarea was misunderstood.
However, it did not mention that a textarea renders text as markdown by default.

Related Issues

• #16

Problem/Motivation

There is no issue template for changing features to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a feature change template built analogue to the feature request template.

Acceptance Criteria

• add a feature change template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

There is no issue template for security raise proposals to make such proposals more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a security template built analogue to the feature request template.

Acceptance Criteria

• add a security template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

Currently, the user name (mine) is hard-coded into the assignee field of all issue templates and forms. However, other people on GitHub (obviously) have other user names. They have to change this in all issue templates and forms manually.

Solution Proposal

Setting the default assignees should be a single-step one-minute task. It should also work on all major desktop operating systems without installing an additional application.

Keep the "assignment" entry empty. Add a script that prompts for default assignees and then appends these or uses these as a replacement in all issue templates and forms.

Impact

No response

Acceptance Criteria

• Add the possibility to append default assignees
  • Create a shell script without auto-commit
  • Create a shell script with auto-commit
  • Create a PowerShell script without auto-commit
  • Create a PowerShell script with auto-commit
• Add the possibility to replace all default assignees
  • Create a shell script without auto-commit
  • Create a shell script with auto-commit
  • Create a PowerShell script without auto-commit
  • Create a PowerShell script with auto-commit
• Add the possibility to delete all default assignees
  • Create a shell script without auto-commit
  • Create a shell script with auto-commit
  • Create a PowerShell script without auto-commit
  • Create a PowerShell script with auto-commit

Further Information

No response

Related Issues

No response

Problem/Motivation

There is no issue template for refactors to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a refactor template built analogue to the feature request template.

Acceptance Criteria

• add a refactor template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

There is no issue template for reporting bugs to make such reports more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a bug report template built analogue to the feature request template.

Acceptance Criteria

• add a bug report template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

The project has a multitude of issue forms and templates that do not always have analogous sections and questions.
This is true as well for future forms and templates.
Currently, the most similar form or template has to be copied initially to create a new form or template.
But then, not only does the phrasing need to be adjusted but sometimes even whole sections have to be copied from elsewhere.

Solution Proposal

Create an issue form and template that holds all repeatedly occurring or generalizable sections that are currently used across all forms and templates of this project.

These sections should be populated with default descriptions (or use placeholder where adequate) and user input fields should be populated with default placeholders.
The order of the sections should be chosen in a way that, ideally, a new form or template (that follows the pattern of existing forms and templates) can be created by simply removing all unneeded sections without reordering them (in case no new type of section has to be created).

The resulting form and the resulting template should be included in a meta folder inside the .github directory.

Impact

If future forms and templates need new types of sections, it can easily be forgotten to update the meta-form and -template as well, which would cause a flawed meta-form or -template.

Acceptance Criteria

• create a meta-form.yml as described in the solution proposal
• create a meta-template.md as described in the solution proposal

Further Information

No response

Related Issues

No response

Problem/Motivation

The visual separation between the issue form's preface and its first input field's heading could be more apparent.
The preface should contain the "Information for contributors about label usage" section to make it less missable.
Optional instructions make the issue form's preface lengthy.

Solution Proposal

Add a "Preface" heading at the start of the preface.
Add a --- separator at the end of the preface.
Move the "Information for contributors about label usage" section into the preface.
Put it into an HTML <details> element like so:

Source code:

<details>
<button><summary><b>Click here for: Concise description</b></summary></button>
    The optional, lengthy content
</details>

Shorten the visual appearance of any other optional instructions in the same way.

Impact

It only works for issue forms and not for issue templates.

Issue templates use plain markdown files, meaning instructions on how to use the template will appear as plain text when filling out an issue template. They can not be styled.

Acceptance Criteria

• Add a "How to use this issue form" heading at the start of the preface for each issue form
• Add a --- separator at the end of the preface for each issue form
• "Information for contributors about label usage"
  • Move this section into the preface for each issue form
  • Apply the described <details> solution for each issue form
• Apply the described <details> solution for all optional preface instructions for each issue form

Further Information

No response

Related Issues

-original issue: #16

Object of Interest

The issue templates

Problem/Motivation

Issue forms enable a better presentation as well as better validation possibilities. They can also enforce using a template when creating a new issue. Also, the issue form configuration file is the single point of truth that contains all information concerning the issue form, like default labels, assignees, etc.

Solution Proposal

Convert every issue template to a GitHub issue form configuration file. Keep the old issue templates to allow for an individual choice between these two options.

The security issue template is excluded because it will be dropped in favor of GitHub's security advisories as mentioned in issue #20.

Impact

When updating a template, it will be necessary to change two files instead of one to keep the contents of the classic issue template and the new issue form synchronous.

Acceptance Criteria

• create bug report form
• create design form
• create documentation form
• create feature change form
• create feature drop form
• create feature request form
• create maintenance form
• create performance form
• create pipeline form
• create question form
• create refactor form
• create testing form
• create text correction form
• create tooling form

Further Information

• configuring issue templates for your repository
• creating issue forms
• syntax for GitHub's form schema
• syntax for issue forms
• Learn YAML in Y minutes

Related Issues

• #20

Problem/Motivation

There is no issue template for design changes to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a design template built analogue to the feature request template.

Acceptance Criteria

• add a design template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

There is no issue template for new features to make feature requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a feature request template to the project.

Acceptance Criteria

• add the content of the code block in Further Information as feature request template

Further Information

<!--
How to use this template:
The feature name has to be written in kebap-case.
Keep all of the text encapsulated in comments, even though it will not be rendered.
Only add text in the places that are filled with *None* default and replace *None* with your text.
-->

# Feature Request: *None* <!-- add-your-feature-name-here -->

## Problem/Motivation
<!-- describe your problem or motivation that caused your feature request as detailed as possible -->
*None*

## Solution Proposal
<!-- describe the solution you have in mind as detailed as possible -->
*None*

## Acceptance Criteria
<!-- specify the acceptance criteria as a task list: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists -->
*None*

## Further Information
<!-- add additional helpful, issue related information such as links, screenshots, sketches, your own considerations and thoughts, etc. -->
*None*

## Related Issues
<!-- add a bullet point list of other related issues in case there are any -->
*None*

<!--
Label usage:
- select any number of fitting labels with a "Flag: " prefix
- select any number of fitting labels with a "For: " prefix
- select EXACTLY ONE label with a "Priority: " prefix
- select EXACTLY ONE label with a "Scope: " prefix
- do not add, change or remove any label with a "Status: " or "Type: " prefix

Look at the label descriptions to get a better understanding of them and pick the most fitting.
If more than one "Type: " label fits the issue, it is a good indicator that the issue mixes concerns.
The issue should then be split into multiple issues in a way that each new issue falls EXACTLY INTO ONE category.
-->

Related Issues

None

Object of Interest

Issue form configuration files and issue templates

Reason

No online writing assistant has proven the text of the templates and issue configuration files.

Solution Proposal

Partly do it in parallel to issue #16:

1. Spell-check and overwork the issue form while creating it out of an issue template.
2. Afterward, update the issue templates with the corrected/updated text from the issue forms on a separate branch.

The security issue template and form are excluded because they will be dropped in favor of GitHub's security advisories as mentioned in issue #20.

Acceptance Criteria

• check bug report form
• update bug report template accordingly
• check design form
• update design template accordingly
• check documentation form
• update documentation template accordingly
• check feature change form
• update feature change template accordingly
• check feature drop form
• update feature drop template accordingly
• check feature request form
• update feature request template accordingly
• check maintenance form
• update maintenance template accordingly
• check performance form
• update performance template accordingly
• check pipeline form
• update pipeline template accordingly
• check question form
• update question template accordingly
• check refactor form
• update refactor template accordingly
• check testing form
• update testing template accordingly
• check text correction form
• update text correction template accordingly
• check tooling form
• update tooling template accordingly

Further Information

None

Related Issues

• #16
• #20

Problem/Motivation

There is no issue template for questions that could uncover problems to make the questions asked more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a question template built analogue to the feature request template.

Acceptance Criteria

• add a question template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

There is no issue template for performance raise proposals to make such proposals more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a performance template built analogue to the feature request template.

Acceptance Criteria

• add a performance template built analogue to the feature request template

Further Information

None

Related Issues

None

Problem/Motivation

There is no issue template for pipeline changes to make such requests more consistent and raise their quality. This is also needed to fulfill the goal of the project.

Solution Proposal

Add a pipeline template built analogue to the feature request template.

Acceptance Criteria

• add a pipeline template built analogue to the feature request template

Further Information

None

Related Issues

None