Skip to content

[ work in progress ] Add GITHUB_TEMPLATES#1010

Closed
rogeruiz wants to merge 2 commits into
18f-pages-stagingfrom
add-github-templates
Closed

[ work in progress ] Add GITHUB_TEMPLATES#1010
rogeruiz wants to merge 2 commits into
18f-pages-stagingfrom
add-github-templates

Conversation

@rogeruiz

Copy link
Copy Markdown
Contributor

Issue and Pull Request templates have landed on Github 🎉. This PR adds templates that can be used by Github when creating issues and pull-requests. Read the blog post linked below for more information. This is currently a work in progress as I'm not sure we have a template to use around submitting Pull Requests

https://github.com/blog/2111-issue-and-pull-request-templates

@rogeruiz

Copy link
Copy Markdown
Contributor Author

CC: @maya, @msecret, @juliaelman

@juliasolorzano

Copy link
Copy Markdown

💯 let's also plan on updating the docs and include a link to these new templates too! https://github.com/18F/web-design-standards/blob/18f-pages-staging/CONTRIBUTING.md#submitting-an-issue

@rogeruiz

Copy link
Copy Markdown
Contributor Author

Looking through my trove of notes on this subject, I found this mega PULL_REQUEST_TEMPLATE that I've used parts of. I don't think we need to actually use all of it. We could pick and choose some sections from this. I like the idea of including a checklist that will help contributors get their PR reviewed and merged quickly.

Short description explaining the high-level reason for the pull request

Additions

Removals

Changes

Testing

Review

  • @user

Screenshots

Todos

Checklist

  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows the standards laid out in the front end playbook
  • Passes all existing automated tests
  • New functions include new tests
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged
  • Visually tested in supported browsers and devices
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)

@juliasolorzano

Copy link
Copy Markdown

Nice! I can see this being very useful, but we should definitely do some user research/testing of our contributors.

@maya

maya commented May 10, 2016

Copy link
Copy Markdown
Contributor

Superseded by #1151.

@maya maya closed this May 10, 2016
@rogeruiz rogeruiz deleted the add-github-templates branch May 11, 2016 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants