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

chore(docs): Add Issue Templates #35

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kwelch
Copy link
Contributor

@kwelch kwelch commented May 7, 2018

Description

I have added the stock issue templates that GH provides. This should be a good starting point for us to clean up/revise to our liking.

fixes #34

How Has This Been Tested?

Screenshots (if appropriate):

Checklist:

  • I have read the CONTRIBUTING document.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have run yarn validate to ensure that tests, typescript and linting are all in order.

Copy link
Contributor

@benmvp benmvp left a comment

Choose a reason for hiding this comment

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

I like this!

So what happens with: https://github.com/eventbrite/eventbrite-sdk-javascript/blob/master/.github/ISSUE_TEMPLATE.md ?

Can you add section for "Possible solution"? I like that


---

**Describe the bug**
Copy link
Contributor

Choose a reason for hiding this comment

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

How about using ## (<h2>) instead of bolding?

@kwelch
Copy link
Contributor Author

kwelch commented May 14, 2018

@benmvp These are the defaults from GitHub. I believe the old is the fallback if they click "These don't apply to me".

I think we can take our current one ISSUE_TEMPLATE.md and using it for BUG_REPORT.

I think for feature request, we may need to write it from scratch.

Personally, I prefer the comment for example approach rather than text that has to be deleted. I also agree with the idea of ## instead of bolding, that is cleaner/clearer in preview.

@benmvp
Copy link
Contributor

benmvp commented May 14, 2018

@kwelch I think our ISSUE_TEMPLATE.md was a mixture of Bug_report.md & Feature_request.md

@benmvp
Copy link
Contributor

benmvp commented May 17, 2024

Can we just close this out 😄 it's showing up in my TODO list and we're clearly not gonna do it (because we don't care haha)

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.

Investigate new issues interface
2 participants