docs: Add issue and pull request templates #31
Conversation
selbekk
requested review from
henrikhermansen,
antidecaf,
kwltrs and
wkillerud
|
Not sure if we need a pull request template as well? |
|
Not sure how we would deal with usage questions. I can add a comment about wiping the template if you have a question. |
This commit adds an issue template that asks some basic questions that will help the user write a descriptive issue.
selbekk
force-pushed
the
9-add-issue-template
branch
from
62e7943
to
0de0938
Compare
selbekk
changed the title
selbekk
changed the title
|
I added a pull request template as well. It's not really a template as much as it's a reminder to adhere to CONTRIBUTING.md guidelines. |
PULL_REQUEST_TEMPLATE.md
Outdated
| Before submitting a pull request, please have a look through the CONTRIBUTING.md | ||
| document. TL;DR: | ||
|
|
||
| - Write proper commit messages tagged with the correct package and scope |
There was a problem hiding this comment.
Mention conventional commits specifically here, perhaps?
There was a problem hiding this comment.
Sure. Do you have a suggestion as to how it should be worded?
There was a problem hiding this comment.
Write proper commit messages tagged with the correct package and scope. We follow the Conventional Commits convention.
... or some such. :)
This commit adds a pull request template, reminding contributors to adhere to our code of conduct and contribution guidelines.
selbekk
force-pushed
the
9-add-issue-template
branch
from
0de0938
to
6d9fe35
Compare
|
@antidecaf ended up with something similar. Unfortunately, this is unparsed markdown, so you can't really have links. Hopefully this will be good enough - at least for a start :) |
docs: Add issue and pull request templates
This pull request adds an issue template that asks some basic questions that will help the user write a descriptive issue.
I'm open for discussing the contents - but I think this is one of those things we improve by using it a lot.
Fixes #9