-
Notifications
You must be signed in to change notification settings - Fork 5k
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
doc: enhance GitHub template. #1482
Conversation
ldez
commented
Apr 22, 2017
- add a pull request template.
- add quick guides to create issue and PR.
- enhance existing issue template.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Important doc/template enhancement, thanks @ldez. 👍
Left some change requests and a few questions.
.github/ISSUE_TEMPLATE.md
Outdated
@@ -0,0 +1,32 @@ | |||
How to write a good issue ? Read [this](https://github.com/containous/traefik/blob/master/.github/how-to-write-a-good-issue.md) and the [contributing guide](https://github.com/containous/traefik/blob/master/.github/CONTRIBUTING.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should use relative links so that reference don't break if we ever change the repo/hoster.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This links are viewed by user who open an issue as text.
If we use relative links, the user can be lost.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right, I forgot that.
Thanks for pointing out. 👍
.github/PULL_REQUEST_TEMPLATE.md
Outdated
@@ -0,0 +1,4 @@ | |||
How to write a good pull request ? Read [this](https://github.com/containous/traefik/blob/master/.github/how-to-write-a-good-pull-request.md) and the [contributing guide](https://github.com/containous/traefik/blob/master/.github/CONTRIBUTING.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Relative links here too.
For other type of questions, consider using one of: | ||
|
||
- the [Traefik community Slack channel](https://traefik.herokuapp.com) | ||
- [StackOverflow](https://stackoverflow.com/questions/tagged/traefik) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I very much like this rule. What I'm wondering though is what kind of consequences are we going to draw from this? I can see two:
- Close question-style issues right away, pointing to Slack/StackOverflow.
- Just tolerate them (and maybe leave a "please use Slack/StackOverflow next time" message).
I know the Kubernetes folks do the former. However, they have to be very rigid due to the sheer amount of issues they receive.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also like it :) I think we can tolerate them, for now. We can change this rule later.
- Make sure all tests pass | ||
- Add tests | ||
- Write useful descriptions and titles | ||
- Keep your branch history clean |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not everyone may have the same understand of what this means. Can we be more specific?
- Make sure all tests pass | ||
- Add tests | ||
- Write useful descriptions and titles | ||
- Keep your branch history clean |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we please add a point
- Address review comments in terms of additional commits; do not amend/squash existing ones unless the PR is trivial.
f22f790
to
c69ef9a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thanks @ldez :)
For other type of questions, consider using one of: | ||
|
||
- the [Traefik community Slack channel](https://traefik.herokuapp.com) | ||
- [StackOverflow](https://stackoverflow.com/questions/tagged/traefik) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also like it :) I think we can tolerate them, for now. We can change this rule later.
.github/ISSUE_TEMPLATE.md
Outdated
@@ -0,0 +1,32 @@ | |||
How to write a good issue ? Read [this](https://github.com/containous/traefik/blob/master/.github/how-to-write-a-good-issue.md) and the [contributing guide](https://github.com/containous/traefik/blob/master/.github/CONTRIBUTING.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't those comments be in html comment <!-- …
? Otherwise it's gonna show up in the final issue if ppl don't clean it (and I guarantee that not everybody will clean those). See https://raw.githubusercontent.com/moby/moby/master/.github/ISSUE_TEMPLATE.md 👼
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a gmail filtering technique 😉
.github/PULL_REQUEST_TEMPLATE.md
Outdated
@@ -0,0 +1,4 @@ | |||
How to write a good pull request ? Read [this](https://github.com/containous/traefik/blob/master/.github/how-to-write-a-good-pull-request.md) and the [contributing guide](https://github.com/containous/traefik/blob/master/.github/CONTRIBUTING.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same for PRs 👼
092158c
to
4ab1ef3
Compare
4ab1ef3
to
253bf44
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🐯
253bf44
to
4f3fa2e
Compare
- add issue and PR guide. - rewrite templates
- fix collides with imported package name.
4f3fa2e
to
972579e
Compare