Skip to content

Adding pull request and issue templates.#1151

Merged
rogeruiz merged 9 commits into
18f-pages-stagingfrom
gh-templates
May 10, 2016
Merged

Adding pull request and issue templates.#1151
rogeruiz merged 9 commits into
18f-pages-stagingfrom
gh-templates

Conversation

@juliasolorzano

Copy link
Copy Markdown

Description

This pull request includes the addition of Github templates for issues and pull requests. It is building off of the initial work done in #1010.

Additional information

@juliasolorzano juliasolorzano changed the title Docs: Adding pull request and issue templates. Adding pull request and issue templates. May 9, 2016
Comment thread .github/CONTRIBUTING.md Outdated
**Additional Info**

*Include any images, steps to recreate, notes, emojis, or whatever.*
To help us get a better understanding of the issue you are submitting, follow our ISSUE TEMPLATE and the guidelines outlined in that document.

@rogeruiz rogeruiz May 9, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's link to the ISSUE_TEMPLATE file here

follow [our ISSUE TEMPLATE](/.github/ISSUE_TEMPLATE.md)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maya would we be doing the same here? linking to the new issue page?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be linked to the new issue page

https://github.com/18F/web-design-standards/issues/new.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as below - if it links to a new issue the text should say "Open a new ISSUE (link to new issue) and follow the template outlined." or if you want to actually link to the issue template page, then make sure the text says that's where they're going.

Kate Garklavs and others added 2 commits May 9, 2016 13:58
Just made a few small copy edits — if you all have questions/concerns about them, Slack me!
Comment thread .github/ISSUE_TEMPLATE.md
1. Step one
2. Step two
3. Step three
4. etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might recommend replacing etc. with And so on OR And so forth. (Reasoning: Our content guide recommends against using etc. because it can feel jarring.)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here faa43f3 - thank you @kategarklavs!

@juliasolorzano

Copy link
Copy Markdown
Author

@bradnunnally @kategarklavs @maya @rogeruiz is this ready to be merged in?

@bradnunnally

Copy link
Copy Markdown
Contributor

Looks good to me @juliaelman

@maya

maya commented May 10, 2016

Copy link
Copy Markdown
Contributor

@juliaelman @bradnunnally - @rogeruiz mentioned wanting to add in an example issue and PR into the CONTRIBUTING doc. @rogeruiz - did you want to do that in this PR or another?

@rogeruiz

Copy link
Copy Markdown
Contributor

This looks good to be merged in, and I can hit the 🔘 on it. The only thing missing for me is an example in the CONTRIBUTING.md of a PR and Issue using the new templates. But I'm also open to us iterating on this based on user's feedback.

@maya I think we can leave it out for now and just merge this in 🚀

@rogeruiz rogeruiz merged commit 21aa5c7 into 18f-pages-staging May 10, 2016
@maya maya deleted the gh-templates branch May 10, 2016 21:31
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.

5 participants