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 GitHub issue template #19706

Merged
merged 4 commits into from May 8, 2016
Merged

Add GitHub issue template #19706

merged 4 commits into from May 8, 2016

Conversation

cvrebert
Copy link
Collaborator

Refs #19260.
CC: @twbs/team for review/feedback

@XhmikosR
Copy link
Member

Are the spaces in brackets and the trailing spaces needed for something special?

If those aren't needed, I'd go with this:

If you're reporting a bug:

* Have you [searched for duplicate issues, including closed issues?]( https://github.com/twbs/bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue ): 
* Have you [validated]( http://validator.w3.org/nu/ ) your page's HTML?: 
* Have you [linted]( https://github.com/twbs/bootlint#in-the-browser ) your page's HTML?: 
* What version of Bootstrap are you using?: 
  * If you're not using the latest version (3.3.6 or 4.0.0-alpha.2), please try upgrading first.
* Which OS are you using?: 
  * [Windows, Mac OS X, Android, iOS, Win10 Mobile]
* Which browser are you using?: 
  * [Chrome, Firefox, Safari, IE, MS Edge, Opera 15+, Android Browser]
* What versions of your OS and browser are you using?: 
* What's the URL of your [reduced test case]( https://css-tricks.com/reduced-test-cases/ )?: 
  * If you don't provide a reduced test case, your issue may get summarily closed.
  * Please use [BootstrapCDN]( https://www.bootstrapcdn.com ) and [JS Bin]( https://jsbin.com ) (or JSFiddle, CodePen, etc.) for your testcase.
  * Full, non-simplified production webpages don't qualify as reduced test cases.

---

If you need help debugging your specific webpage or have a "How do I...?" question,
**DON'T** open an issue. Ask for help on StackOverflow, IRC, or Slack instead.
See <https://github.com/twbs/bootstrap/blob/master/README.md#community> for links to those personal support forums.

---

If you have a feature request:

* Have you [searched for duplicate issues, including closed issues?]( https://github.com/twbs/bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue ): 
* Note that your request will only be considered for Bootstrap 4.
  * [Bootstrap 3 is no longer receiving new features.]( https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#feature-requests )
* Please describe your idea in as much detail as possible. (Terse or unclear requests may get summarily closed.)

---

If you need help debugging your specific webpage or have a "How do I...?" question,
**don't** open an issue. Ask for help on StackOverflow, IRC, or Slack instead.
See <https://github.com/twbs/bootstrap/blob/master/README.md#community> for links to those personal support forums.

---

If you have a feature request:

* Have you [searched for duplicate issues, including closed issues?](https://github.com/twbs/bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue):
* Note that your request will only be considered for Bootstrap 4.
  * [Bootstrap 3 is no longer receiving new features.](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#feature-requests)
* Please describe your idea in as much detail as possible. (Terse or unclear requests may get summarily closed.)

@patrickhlauke
Copy link
Member

LGTM

worth linking to https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#using-the-issue-tracker as well somewhere?

@XhmikosR
Copy link
Member

Also, maybe we shouldn't hardcode the latest version and instead link to releases or something?

@cvrebert
Copy link
Collaborator Author

Are the spaces in brackets and the trailing spaces needed for something special?

In the brackets, I thought it would make it easier for the user to copy the URLs, since they're probably reading the raw Markdown rather than the rendered Markdown.

The trailing spaces are so the user doesn't have to type those themselves when answering the questions.

Also, maybe we shouldn't hardcode the latest version and instead link to releases or something?

I don't think folks would appreciate having to chase that layer of indirection. People are lazy.

@XhmikosR
Copy link
Member

In the brackets, I thought it would make it easier for the user to copy the URLs, since they're probably reading the raw Markdown rather than the rendered Markdown.

The trailing spaces are so the user doesn't have to type those themselves when answering the questions.

OK, I updated the patch in #19706 (comment)

I don't think folks would appreciate having to chase that layer of indirection. People are lazy.

So, we'll need to change the version here too? Or will the change-version task handle this right?

@cvrebert
Copy link
Collaborator Author

worth linking to https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#using-the-issue-tracker as well somewhere?

Not sure. The template text covers the "personal support requests" point.
The "Please do not derail or troll issues" point mostly concerns comments and is unlikely to affect troll OPs.
The 'Please do not post comments consisting solely of "+1"' point is about comments, not OPs.
The Normalize point comes up fairly infrequently.
The Themes point, yeah, probably we should a line to the template about that?

@cvrebert
Copy link
Collaborator Author

So, we'll need to change the version here too? Or will the change-version task handle this right?

It'll handle the master version. The other version will probably have to be manual.

@cvrebert
Copy link
Collaborator Author

OK, I updated the patch in #19706 (comment)

So, your patch bolds the "don't", adds some blank lines, and adds <>s around raw URLs? Anything else?

@XhmikosR
Copy link
Member

Yeah.
On Apr 10, 2016 23:24, "Chris Rebert" notifications@github.com wrote:

OK, I updated the patch in #19706
#19706 (comment)

So, your patch bolds the "don't"s, adds some blank lines, and adds <>s
around raw URLs? Anything else?


You are receiving this because you are on a team that was mentioned.
Reply to this email directly or view it on GitHub
#19706 (comment)

@cvrebert
Copy link
Collaborator Author

The <>s just seem like they'd make copy-pasting harder, and they don't affect the rendered result.

@XhmikosR
Copy link
Member

Fine with me.
On Apr 10, 2016 23:34, "Chris Rebert" notifications@github.com wrote:

The <>s just seem like they'd make copy-pasting harder, and they don't
affect the rendered result.


You are receiving this because you are on a team that was mentioned.
Reply to this email directly or view it on GitHub
#19706 (comment)

@cvrebert
Copy link
Collaborator Author

@mdo Your thoughts, Generalissimo?

@mdo
Copy link
Member

mdo commented Apr 11, 2016

This is a rad start, but it's a bit long in the tooth. Seeing that huge block of text makes my eyes blur a bit. Can we condense it down to something like this?

Before opening an issue:

- [Search for duplicate or closed issues](https://github.com/twbs/bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue) for bugs and feature requests
- [Validate](http://validator.w3.org/nu/) and [lint](https://github.com/twbs/bootlint#in-the-browser) any HTML to avoid common problems
- Prepare a [reduced test case](https://css-tricks.com/reduced-test-cases/) for any bugs
- Read the [full contributing guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md)

When asking general "how to" questons:

- Do not open an issue
- Ask for help on [StackOverflow, IRC, or Slack instead](https://github.com/twbs/bootstrap/blob/master/README.md#community)

When reporting a bug, include:

- Operating system and version (Windows, Mac OS X, Android, iOS, Win10 Mobile)
- Browser and version (Chrome, Firefox, Safari, IE, MS Edge, Opera 15+, Android Browser)
- URLs reduced test cases and potential fixes using [BootstrapCDN](https://www.bootstrapcdn.com) and [JS Bin](https://jsbin.com)

When suggesting a feature, include:

- As much detail as possible for what we should add and why it's important to Bootstrap
- Relevant links to prior art, screenshots, or live demos whenever possible

Changes mostly focused on:

  • Clearer headings between sections
  • De-duped the search/closed bits by addressing it at the top
  • Removed or consolidated some of the verbiage and recommendations (e.g., skipped everything but JS Bin and combined browser/OS/version bits)
  • Cleaned up Markdown formatting (what was with the spaces around the parens, was that intentional?)

Overall though, I'd like to whittle this down even further. This content is unlikely to be rendered in the preview by anyone even though it's passed into the value of the textarea. We should expect that folks look no further than this textarea for guidance, but we shouldn't overload it.

@dustinlapierre
Copy link

Has this issue been solved yet, because I've been looking for an easy beginner issue to get me started with GitHub contributions and this caught my eye?

@cvrebert
Copy link
Collaborator Author

@dustinlapierre Appreciate the thought, but this isn't a beginner issue.

@mdo mdo merged commit 1506347 into v4-dev May 8, 2016
@mdo mdo deleted the issue-template branch May 8, 2016 20:41
@mdo
Copy link
Member

mdo commented May 8, 2016

Will need to add a separate v3 one later.

@mdo mdo mentioned this pull request May 8, 2016
cvrebert added a commit that referenced this pull request Jun 4, 2016
[ci skip]
chiraggmodi pushed a commit to chiraggmodi/bootstrap that referenced this pull request Apr 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants