Skip to content
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

doc: trim GitHub template comments #6755

Closed
wants to merge 1 commit into from
Closed

Conversation

Trott
Copy link
Member

@Trott Trott commented May 14, 2016

Checklist
  • tests and code linting passes
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

Make the comments in the GitHub templates slightly more concise.

/cc @indutny

@Trott Trott added the doc Issues and PRs related to the documentations. label May 14, 2016
@nodejs-github-bot nodejs-github-bot added the meta Issues and PRs related to the general management of the project. label May 14, 2016
the template below by replacing the html comments with an appropriate answer.
If unsure about something, just do as best as you're able.
Thank you for reporting an issue. Please fill in the template below. If unsure
about something, just do as best as you're able.

version: usually output of `node -v`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about capitalizing the field names here to match the actual content (and to make them stand out better)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mscdex Good idea. Done.

@jbergstroem
Copy link
Member

LGTM

review below requirements and walk through the checklist. You can 'tick'
a box by using the letter "x": [x].
Thank you for your pull request. Please review below requirements and walk
through the checklist. You can 'tick' a box by using the letter "x": [x].

Run the test suite by invoking: `make -j4 lint test` on linux or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While you're here: "Run the test suite with:" and "on UNIX"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make test already includes lint. make -j4 test

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While you're here: "Run the test suite with:" and "on UNIX"?

Done and done.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make test already includes lint. make -j4 test

lint removed

@bnoordhuis
Copy link
Member

LGTM with a suggestion.

@Fishrock123
Copy link
Contributor

Can we get rid of the blank lines between the headings and the comments?

### thing
<!-- description -->

@jasnell
Copy link
Member

jasnell commented May 14, 2016

Rubber stamp LGTM.

@Trott
Copy link
Member Author

Trott commented May 15, 2016

Can we get rid of the blank lines between the headings and the comments?

We sure can! Done!

Make the comments in the GitHub templates slightly more concise.
@rvagg
Copy link
Member

rvagg commented May 15, 2016

lgtm
trim trim trim
the less text the more chance it'll be read

The last para is horribly verbose, mostly redundant and simply sounds like someone's trying too hard to be nice and unfortunately it becomes long enough that it's likely to be left unread by many.

It will be much easier for us to fix the issue if a test case that reproduces the problem is provided. Ideally this test case should not have any external dependencies. We understand that it is not always possible to reduce your code to a small test case, but we would appreciate to have as much data as possible.

[I'd rather remove it, but] it could become something like:

If possible, please provide a test case to reproduce the problem, keep it simple so we can run it.

I'd love to see data on whether any of the text in these templates has changed behaviour at all. It's probably an unreasonable request but I'm highly skeptical that we're getting much value out of these and it's just contributing to the noise and raising barriers to entry.

@Fishrock123
Copy link
Contributor

Fishrock123 commented May 15, 2016

@rvagg We do actually usually find these at least attempted to be filled in as far as I have seen..

I think we should minimize the language and make it as concise as possible but I think keeping it is also a good idea.

@jasnell
Copy link
Member

jasnell commented May 17, 2016

Still LGTM. Would love it if we can find ways of trimming more.

Trott added a commit to Trott/io.js that referenced this pull request May 17, 2016
Make the comments in the GitHub templates slightly more concise.

PR-URL: nodejs#6755
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
@Trott
Copy link
Member Author

Trott commented May 17, 2016

Landed in 42ede93

@Trott Trott closed this May 17, 2016
evanlucas pushed a commit that referenced this pull request May 17, 2016
Make the comments in the GitHub templates slightly more concise.

PR-URL: #6755
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
@Trott Trott deleted the templates branch January 13, 2022 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants