How about something like this for a PR template? #### What does this PR do? Is there a relevant Github issue?
#### What is the best way to verify this PR? #### Does your PR include any of the following? - [ ] Tests - [ ] Documentation - [ ] CHANGELOG.md entry On Tue, Feb 27, 2018 at 10:46 AM, Jeremy Mitchell <mitchell...@gmail.com> wrote: > With an issue and/or pr template, we will have 6/6 items checked: > > https://github.com/apache/incubator-trafficcontrol/community > > I actually think PR templates would be quite helpful. As a > committer/merger, it would be nice to know what problem the PR is solving > and how to verify the functionality. A PR template could also help > contributors ensure that their PRs are complete. I.e. does this PR includes > tests, documentation, etc. > > I'll take a stab at a couple of templates and run them by the group. > > Jeremy > > On Wed, Jan 31, 2018 at 1:10 PM, Chris Lemmons <alfic...@gmail.com> wrote: > >> I'm +1 on Issue Templates, for sure. I don't know that PR templates >> are quite as critical, but it might be nice to have a reminder in >> there about verifying that the changelog is updated if necessary and >> documentation for new features is present. If the PR Template >> overwrites the default comment that you get from the commit body, it >> might be more annoying than valuable, though. >> >> I'm also +1 on hiding these particular files in a .github directory. >> Unlike CONTRIBUTING and README, they don't provide all that much >> benefit for a new person looking for stuff to read. >> >> On Wed, Jan 31, 2018 at 12:17 PM, Durfey, Ryan <ryan_dur...@comcast.com> >> wrote: >> > Always +1 on standardization and consistency >> > >> > I still want to circle back and setup project/kanbans for organizing >> tickets in Github. >> > >> > Ryan Durfey M | 303-524-5099 >> > CDN Support (24x7): 866-405-2993 or cdn_supp...@comcast.com<mailto: >> cdn_supp...@comcast.com> >> > >> > From: Dewayne Richardson <dewr...@gmail.com> >> > Reply-To: "dev@trafficcontrol.incubator.apache.org" < >> dev@trafficcontrol.incubator.apache.org> >> > Date: Wednesday, January 31, 2018 at 11:15 AM >> > To: "dev@trafficcontrol.incubator.apache.org" < >> dev@trafficcontrol.incubator.apache.org> >> > Subject: Github PR/Issues Format Templates >> > >> > I was working through the go-swagger repo and found a bug. I submitted >> a >> > new issue and found this interesting approach I think the TC github >> should >> > adopt, "Issue and PR Templates". I think the main value here is >> > consistency in our PRs/Issues and user friendly prompts to say "these >> are >> > the data points we need to help you solve your issue". >> > >> > Working example: >> > https://github.com/go-swagger/go-swagger/issues/new >> > >> > Github Doc on how to implement templates: >> > https://github.com/blog/2111-issue-and-pull-request-templates >> > >> > If we think it's a good idea, then I'll respond with some examples for >> > Issues and PR's that we can discuss. >> > >> > -Dew >> > >> > >
