Add contributing templates #2553
Conversation
|
General (quick) recommendations:
|
|
|
||
| ## Bug Report Template | ||
|
|
||
| ### Subject of the issue |
There was a problem hiding this comment.
Unnecessary, because an issue already has a title/subject field
|
I've addressed the comments above, thank you, any further thoughts @pfiller, @kenearley, @stof, @koenpunt, and @tjschuck?
|
| 2. This is the second step | ||
| 3. Further steps, etc. | ||
|
|
||
| Please provide a working demo, you can use [this template](https://jsfiddle.net/Pezmc/5v3v353z/) as a base. |
There was a problem hiding this comment.
I would prefer an anonymous demo fiddle; https://jsfiddle.net/5v3v353z/
|
I take my previous comment back, if no one has any further objections/suggestions before EOD I'm going to go ahead and merge. We can always adjust these templates in follow ups. |
|
We might consider putting these files in a |
|
@koenpunt Tidied into |
|
I'm OK with this, but @pfiller will get the final word. But he's not around ATM, so could take a few days. |
|
|
||
| Please provide a working demo, you can use [this template](https://jsfiddle.net/hyktf3he) as a base. | ||
|
|
||
| ### Expected behaviour |
There was a problem hiding this comment.
@Pezmc I think you mean "behavior".
🇺🇸 🇺🇸 🇺🇸 🇺🇸 🇺🇸 🇺🇸 🇺🇸 🇺🇸 🇺🇸
|
@pfiller probably doesn't care :) I'll self-assign. @Pezmc I agree with including these, but honestly, I think they should be simplified quite a bit. I'm going to make some additional commits directly to this right now. If you're 👍 on my changes, then let's just call it good enough for now — you can merge, and we'll 💅 from there. Stay tuned... |
|
We probably want to squash these commits 📦 |
tjschuck
force-pushed
the
add-contributing-templates
branch
from
c576be7
to
004ef7d
Compare
|
@koenpunt @Pezmc Okay, I made my edits. My primary focus was to largely tighten them up — brevity will hopefully encourage adherence (or, y'know, reading them at all). My most controversial change is probably 19127e3, removing the templating for Feature Requests altogether. My reasoning was (a.) brevity again, but (b.) these issues aren't generally missing information and needing follow-up, so let's not optimize for them. But feel free to tell me if you disagree. MD-rendered versions here: |
|
I'd say squash it and ship it 🚀 |
Following https://help.github.com/articles/creating-an-issue-template-for-your-repository/ Adapted from: - https://github.com/harvesthq/chosen/blob/master/contributing.md - https://github.com/necolas/issue-guidelines - https://github.com/angular-translate/angular-translate/blob/master/ISSUE_TEMPLATE.md - https://raw.githubusercontent.com/Urigo/angular-meteor/master/.github/ISSUE_TEMPLATE.md
tjschuck
force-pushed
the
add-contributing-templates
branch
from
004ef7d
to
d253dce
Compare
Last week GitHub announced support for templates for Issues and Pull Requests to projects to try and help contributors add the right details at the start of a thread.
Given the large number of issues/PRs Chosen gets, adding some templates may help make things a little more manageable.
I've put together a proposed ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE, which were mostly based on the existing contributing.md.
Do you think these will be of value? Do you have any proposed changes to my drafts?