Skip to content

Commit 535478d

Browse files
janiceilenezekemyarb
authored
Update templates for open sourcing (github#15905)
Co-authored-by: Zeke Sikelianos <zeke@sikelianos.com> Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com>
1 parent 2b70261 commit 535478d

7 files changed

Lines changed: 88 additions & 99 deletions

File tree

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Start a discussion
4+
url: https://github.com/github/docs/discussions/new
5+
about: Use a discussion to suggest a new idea or share what you've learned in our docs.
6+
- name: GitHub Support
7+
url: https://support.github.com/contact
8+
about: Contact Support if you're having trouble with your GitHub account.

‎.github/ISSUE_TEMPLATE/engineering-issue.md‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/enterprise-release.md‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/improve-existing-docs.md‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
11
---
2-
name: Docs content issues have moved!
3-
about: Create an issue about existing content (not upcoming releases/ships), whether reported by users or noticed by Hubbers.
2+
name: Improve existing docs
3+
about: Make a suggestion to improve our existing documentation.
44
title: ''
55
labels:
6-
- Improve existing docs
6+
- content
77
assignees: ''
88
---
9-
# Docs content issues have moved!
9+
<!--
10+
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.
11+
-->
1012

11-
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:
13+
<!--
14+
For questions, ask in Discussions: https://github.com/github/docs/discussions
1215
13-
# :boom::point_right:[new issue templates](https://github.com/github/docs-content/issues/new/choose):point_left::boom:
16+
Before you file an issue read the:
17+
- Code of Conduct: https://github.com/github/docs/blob/onboarding/CODE_OF_CONDUCT.md
18+
- Contributing guide: https://github.com/github/docs/blob/onboarding/CONTRIBUTING.md
19+
20+
Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
21+
-->
22+
23+
### What article on docs.github.com is affected?
24+
25+
<!-- Please link to the article you'd like to see updated -->
26+
27+
### What part(s) of the article would you like to see updated?
28+
29+
<!-- 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? -->
30+
31+
### Additional information
32+
33+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/improve-the-site.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Improve the docs.github.com site
3+
about: Make a suggestions or report a problem on the docs.github.com website.
4+
title: ''
5+
labels: engineering
6+
assignees: ''
7+
---
8+
9+
<!--
10+
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.
11+
-->
12+
13+
<!--
14+
For questions, ask in Discussions: https://github.com/github/docs/discussions
15+
16+
Before you file an issue read the:
17+
- Code of Conduct: https://github.com/github/docs/blob/onboarding/CODE_OF_CONDUCT.md
18+
- Contributing guide: https://github.com/github/docs/blob/onboarding/CONTRIBUTING.md
19+
20+
Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
21+
-->
22+
23+
### What is the current behavior?
24+
25+
<!-- include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. -->
26+
27+
### What changes are you suggesting?
28+
29+
<!-- 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? -->
30+
31+
### Additional information
32+
33+
<!-- Any additional information, configuration, or data that might be necessary to reproduce the issue. -->

‎.github/ISSUE_TEMPLATE/issue-party.md‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
1+
<!--
2+
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.
3+
-->
4+
15
<!--
26
Hello! Thanks for your interest in contributing to this project.
37
4-
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.
8+
Before opening a PR, please see our [CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) for information how to contribute.
9+
10+
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).
11+
12+
Thanks again! :octocat:
13+
-->
14+
15+
### Why:
516

6-
Please link to a corresponding issue when you open a PR:
17+
<!--
718
- If there's an existing issue for your change, please link to it.
8-
- 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.
19+
- 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. -->
920

10-
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=).
21+
### What's being changed:
1122

12-
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`.
23+
<!-- Share artifacts of the changes, be they code snippets, GIFs or screenshots; whatever shares the most context. -->
1324

14-
Thanks again! :octocat:
15-
-->
25+
### Check off the following:
26+
- [ ] All of the tests are passing.
27+
- [ ] I have reviewed my changes in staging.
28+
- [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md)
29+
- [ ] 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 commit comments

Comments
 (0)