New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce the verbosity of the github templates #8435

Merged
merged 2 commits into from Jun 25, 2018

Conversation

Projects
None yet
5 participants
@feerrenrut
Contributor

feerrenrut commented Jun 25, 2018

Link to issue number:

See comments on #8417

Summary of the issue:

Essentially we are trying to reduce the verbosity of the issue / PR templates, and reduce the effort of having to delete text in the template.

Description of how this pull request fixes the issue:

The explanations and examples that were in the templates have been moved out to two wiki pages:
https://github.com/nvaccess/nvda/wiki/Github-issue-template-explanation-and-examples
https://github.com/nvaccess/nvda/wiki/Github-pull-request-template-explanation-and-examples

The description at the top of the file has been reworded and shortened, it is now in a HTML comment so that it can be left in place without polluting the rendered issue.

Testing performed:

Used the Github preview to ensure that the template renders as expected.

Known issues with pull request:

Some users may find it difficult to provide the required information or follow the formatting of the template.

Change log entry:

None

@michaelDCurran

I feel that the introduction for the issue template could be stripped back even further. Similar to the pull request template. E.g. markdown syntax, attaching log files, screen shots, and switching to the preview tab could all be moved into the wiki article. All the introduction need say is please thoroughly read the article before filling in this template. Issues may be closed if the required information is not present.

Reduce imitial comment on issue template
This information has been moved to the wiki.
Review actions for #8435

@feerrenrut feerrenrut merged commit 0b546d3 into master Jun 25, 2018

1 check passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details

@nvaccessAuto nvaccessAuto added this to the 2018.3 milestone Jun 25, 2018

@DrSooom

This comment has been minimized.

DrSooom commented Jun 25, 2018

The current draft with only 722 characters is now much more easier to fill out. Let's hope that beginners will read the wiki article. btw: I didn't know that HTML commands are allowed on GitHub.

Well, and as far as I see GitHub allows uploading *.log files. Changing the file extension to ".txt" shouldn't be necessary anymore. See: https://github.com/nvaccess/nvda/wiki/LogFilesAndCrashDumps

@Brian1Gaff

This comment has been minimized.

Brian1Gaff commented Jun 25, 2018

@Brian1Gaff

This comment has been minimized.

Brian1Gaff commented Jun 25, 2018

@Brian1Gaff

This comment has been minimized.

Brian1Gaff commented Jun 25, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment