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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: better templates for GitHub issues #3202

Merged
merged 1 commit into from Jun 24, 2019

Conversation

Projects
None yet
4 participants
@bajtos
Copy link
Member

commented Jun 21, 2019

Let's leverage GitHub's ability to offer users multiple issue templates and let us decide which issue labels to apply depending on the template chosen.

The proposed templates are loosely inspired by:

Link to our previous discussion about issue template(s): #979

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 raymondfeng, dhmlau and strongloop/loopback-maintainers Jun 21, 2019

@bajtos

This comment has been minimized.

Copy link
Member Author

commented Jun 21, 2019

You can try out the proposed templates here: https://github.com/bajtos/issue-template-test/issues/new/choose

@bajtos bajtos force-pushed the chore/better-issue-templates branch from 7b1df8c to 9f01d05 Jun 21, 2019

@bajtos bajtos self-assigned this Jun 21, 2019

Show resolved Hide resolved .github/ISSUE_TEMPLATE/Bug_report.md
@@ -0,0 +1,25 @@
---
name: Question
about: The issue tracker is not for questions. Please use Stack Overflow or other resources for help.

This comment has been minimized.

Copy link
@dhmlau

dhmlau Jun 21, 2019

Contributor

I thought we still are good to allow questions to be submitted here, however, not encouraged?

This comment has been minimized.

Copy link
@bajtos

bajtos Jun 21, 2019

Author Member

Good point. Can you propose a better version of this text please?

This comment has been minimized.

Copy link
@bajtos

bajtos Jun 21, 2019

Author Member

Feel free to edit the template directly, it may be the fastest way.

@b-admike
Copy link
Member

left a comment

I like the proposals and the distinction of different types of issues users can (or cannot) create.

@bajtos bajtos force-pushed the chore/better-issue-templates branch from f2efdeb to 78f9792 Jun 24, 2019

@bajtos

This comment has been minimized.

Copy link
Member Author

commented Jun 24, 2019

I am going to land this pull request as-is. We can improve the template for Questions in follow-up pull requests.

@bajtos bajtos merged commit 9b89403 into master Jun 24, 2019

4 checks passed

clahub All contributors have signed the Contributor License Agreement.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 91.813%
Details

@delete-merged-branch delete-merged-branch bot deleted the chore/better-issue-templates branch Jun 24, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.