Skip to content

chore: improve issue templates#4030

Merged
bajtos merged 1 commit into
masterfrom
chore/improve-issue-templates
Nov 12, 2019
Merged

chore: improve issue templates#4030
bajtos merged 1 commit into
masterfrom
chore/improve-issue-templates

Conversation

@bajtos

@bajtos bajtos commented Oct 31, 2019

Copy link
Copy Markdown
Member

Leverage the recently introduced GitHub feature and rework our issue picker:

  • Disallow free-form issue creation, force users to pick Feature or Bug
  • Replace Security item with a link explaining how to disclose
    vulnerabilities via email
  • Replace Question item with a link to StackOverflow and our mailing
    list

See https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser

You can view the proposed picker here:
https://github.com/bajtos/test-issue-templates/issues/new/choose

Screen Shot 2019-10-31 at 16 36 34

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

@bajtos
bajtos requested review from a team, dhmlau and raymondfeng October 31, 2019 15:36
@bajtos bajtos self-assigned this Oct 31, 2019
@bajtos

bajtos commented Oct 31, 2019

Copy link
Copy Markdown
Member Author

See also loopbackio/loopback.io#901

@raymondfeng

Copy link
Copy Markdown
Contributor

I'm not sure if we should completely block users from opening issues for questions.

@bajtos

bajtos commented Nov 1, 2019

Copy link
Copy Markdown
Member Author

@raymondfeng

I'm not sure if we should completely block users from opening issues for questions.

Yeah, I am not sure about this part either. So what should we do instead? Do we want to keep links to StackOverflow and our mailing list in addition to an item allowing to post questions to GitHub?

@raymondfeng

Copy link
Copy Markdown
Contributor

Do we want to keep links to StackOverflow and our mailing list in addition to an item allowing to post questions to GitHub?

I think so. Can we open up a channel on LoopBack slack?

@dhmlau

dhmlau commented Nov 5, 2019

Copy link
Copy Markdown
Member

I'm thinking:

  • we are not really monitoring StackOverflow. If we're pointing our users to SO, it probably implies it's a venue that the community users are helping each other out
  • +1 on opening up the Slack channel. I think we wanted to do it for quite some time. Maybe we can slowly introduce Slack channel.. in replacement of the question github issue and gitter?
  • Therefore, for now, I'd prefer not to eliminate the question option in the issue template yet.

@bajtos

bajtos commented Nov 11, 2019

Copy link
Copy Markdown
Member Author

Fair enough. I brought back Question type. Here is a screenshot of the updated issue selector (see https://github.com/bajtos/test-issue-templates/issues/new/choose):

Screen Shot 2019-11-11 at 10 11 42

@raymondfeng @dhmlau LGTY now?

@bajtos

bajtos commented Nov 11, 2019

Copy link
Copy Markdown
Member Author

we are not really monitoring StackOverflow. If we're pointing our users to SO, it probably implies it's a venue that the community users are helping each other out

I am trying to check for new LoopBack-related questions on StackOverflow once a week (on Friday), but quite often I run out of time on PR reviews & issue triage before I get to Stack Overflow :(

How about the mailing list? Is anybody watching it? I am definitely not watching at all.

It would be great if we can start watching these two venues as a team.

Until then, maybe we should improve the messaging and make it clear that both StackOverflow & the mailing list are venues for community users helping each other? That may incentivize people to fill questions on GitHub though.

BTW how about our Gitter room, do we want to mention it here in issue templates too?

- Disallow free-form issue creation, force users to pick
  Feature, Bug or Question
- Replace Security item with a link explaining how to disclose
  vulnerabilities via email
- Add links to StackOverflow and our mailing list

Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
@bajtos
bajtos force-pushed the chore/improve-issue-templates branch from 48fd9a0 to bd4760f Compare November 11, 2019 09:34
@bajtos

bajtos commented Nov 11, 2019

Copy link
Copy Markdown
Member Author

Anyhow. I am proposing to land this pull request as the first step on our journey to improve our issue templates. We can discuss and make further changes later, once this initial PR is landed.

/cc @raymondfeng @dhmlau

@raymondfeng

Copy link
Copy Markdown
Contributor

FYI: I watch the mailing list.

@bajtos
bajtos merged commit 5806447 into master Nov 12, 2019
@bajtos
bajtos deleted the chore/improve-issue-templates branch November 12, 2019 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants