Skip to content

Commit

Permalink
Update templates for open sourcing (github#15905)
Browse files Browse the repository at this point in the history
Co-authored-by: Zeke Sikelianos <[email protected]>
Co-authored-by: Melanie Yarbrough <[email protected]>
  • Loading branch information
3 people authored Oct 7, 2020
1 parent 2b70261 commit 535478d
Show file tree
Hide file tree
Showing 7 changed files with 88 additions and 99 deletions.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Start a discussion
url: https://github.com/github/docs/discussions/new
about: Use a discussion to suggest a new idea or share what you've learned in our docs.
- name: GitHub Support
url: https://support.github.com/contact
about: Contact Support if you're having trouble with your GitHub account.
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/engineering-issue.md

This file was deleted.

15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE/enterprise-release.md

This file was deleted.

32 changes: 26 additions & 6 deletions .github/ISSUE_TEMPLATE/improve-existing-docs.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,33 @@
---
name: Docs content issues have moved!
about: Create an issue about existing content (not upcoming releases/ships), whether reported by users or noticed by Hubbers.
name: Improve existing docs
about: Make a suggestion to improve our existing documentation.
title: ''
labels:
- Improve existing docs
- content
assignees: ''
---
# Docs content issues have moved!
<!--
HUBBERS BEWARE! THIS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
-->

When we open source this repository in October :tada: all of our issue templates will be visible to the public. From now on, you can open new docs issues for docs.github.com in our internal [docs-content repo](https://github.com/github/docs-content) :dizzy:
<!--
For questions, ask in Discussions: https://github.com/github/docs/discussions
# :boom::point_right:[new issue templates](https://github.com/github/docs-content/issues/new/choose):point_left::boom:
Before you file an issue read the:
- Code of Conduct: https://github.com/github/docs/blob/onboarding/CODE_OF_CONDUCT.md
- Contributing guide: https://github.com/github/docs/blob/onboarding/CONTRIBUTING.md
Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
-->

### What article on docs.github.com is affected?

<!-- Please link to the article you'd like to see updated -->

### What part(s) of the article would you like to see updated?

<!-- Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? -->

### Additional information

<!-- Add any other context or screenshots about the feature request here. -->
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/improve-the-site.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Improve the docs.github.com site
about: Make a suggestions or report a problem on the docs.github.com website.
title: ''
labels: engineering
assignees: ''
---

<!--
HUBBERS BEWARE! THIS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
-->

<!--
For questions, ask in Discussions: https://github.com/github/docs/discussions
Before you file an issue read the:
- Code of Conduct: https://github.com/github/docs/blob/onboarding/CODE_OF_CONDUCT.md
- Contributing guide: https://github.com/github/docs/blob/onboarding/CONTRIBUTING.md
Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
-->

### What is the current behavior?

<!-- include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. -->

### What changes are you suggesting?

<!-- Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? -->

### Additional information

<!-- Any additional information, configuration, or data that might be necessary to reproduce the issue. -->
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/issue-party.md

This file was deleted.

28 changes: 21 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
<!--
HUBBERS BEWARE! THIS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
-->

<!--
Hello! Thanks for your interest in contributing to this project.
Before opening a PR, please see our [CONTRIBUTING.md](https://github.com/github/docs-internal/blob/main/CONTRIBUTING.md) for information about how we discuss and track changes.
Before opening a PR, please see our [CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) for information how to contribute.
For changes to content in [site policy](https://github.com/github/docs/tree/main/content/github/site-policy), see the [CONTRIBUTING guide in the site-policy repo](https://github.com/github/site-policy/blob/main/CONTRIBUTING.md).
Thanks again! :octocat:
-->

### Why:

Please link to a corresponding issue when you open a PR:
<!--
- If there's an existing issue for your change, please link to it.
- If there's _not_ an existing issue, please open one first according to the contributing guidelines: https://github.com/github/docs-internal/issues/new/choose.
- If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/github/docs/issues/new/choose. -->

For code/platform related requests, please open a Docs Engineering support request using [this template](https://github.com/github/docs-internal/issues/new?assignees=&labels=engineering&template=engineering-issue.md&title=).
### What's being changed:

For changes to content in [site policy](https://github.com/github/docs-internal/tree/main/content/github/site-policy), please use the [site policy PR template](https://github.com/github/site-policy-internal/blob/master/site-policy-PR-template.md) in this PR and make sure to include the ping to `@github/site-policy-admins`.
<!-- Share artifacts of the changes, be they code snippets, GIFs or screenshots; whatever shares the most context. -->

Thanks again! :octocat:
-->
### Check off the following:
- [ ] All of the tests are passing.
- [ ] I have reviewed my changes in staging.
- [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md)
- [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md).

0 comments on commit 535478d

Please sign in to comment.