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

Add an ISSUE_TEMPLATE #7105

Merged
merged 1 commit into from
Mar 23, 2016

Conversation

fkaelberer
Copy link
Contributor

Github recently introduced issue templates that help contributors to provide necessary information.
I think this should reduce the number of information requests. What do you think about such a template?

https://github.com/blog/2111-issue-and-pull-request-templates

Edit: Try the template at https://github.com/fkaelberer/pdf.js/issues/new, resulting issues look like fkaelberer#4.

#### Steps to reproduce the behavior

---
##### Link to PDF file
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps it would be a good idea to also indicate that GitHub now supports attaching PDF files to issues?

@Snuffleupagus
Copy link
Collaborator

I think this is a great idea!
Besides my comment above, would it make sense to also add a link to https://github.com/mozilla/pdf.js/blob/master/CONTRIBUTING.md at the top of the template (e.g. "Please also read CONTRIBUTING.md", or something like that)?

@yurydelendik
Copy link
Contributor

"Please also read CONTRIBUTING.md"

We can keep this out. However I would move both ISSUE_TEMPLATE.md and CONTRIBUTING.md into .github/ folder (as post suggested)

@yurydelendik
Copy link
Contributor

I was thinking about something less busy (similar to what chromium project had), e.g.:

Link to PDF file (or attach file here):

Configuration:
- Web browser and its version:
- Operating system and its version:
- PDF.js version:
- Is an extension:

Steps to reproduce the problem:
1. 
2.

What is the expected behavior? (add screenshot)

What went wrong? (add screenshot)

Link to a viewer (if hosted on a site other than mozilla.github.io/pdf.js or as Firefox/Chrome extension):

P.S. modified

@timvandermeij
Copy link
Contributor

I definitely think we should add this. I like @yurydelendik's suggestion as it's more compact, yet still contains all required information.

@fkaelberer
Copy link
Contributor Author

Thanks for your feedback. @yurydelendik, I used your text.

@timvandermeij timvandermeij merged commit e1ac574 into mozilla:master Mar 23, 2016
@timvandermeij
Copy link
Contributor

Looks good, thank you! I'm confident that this will lead to better issue descriptions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants