From 9cb1f911215d64e02e30677bbd8b3b2799b158b2 Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Sun, 7 Mar 2021 11:54:33 +0000 Subject: [PATCH 1/2] adding issue/pr templates --- .github/ISSUE_TEMPLATE/content-bug.md | 33 +++++++++++++++++++ .../ISSUE_TEMPLATE/new-content-suggestion.md | 27 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE | 6 ++++ 3 files changed, 66 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/content-bug.md create mode 100644 .github/ISSUE_TEMPLATE/new-content-suggestion.md create mode 100644 .github/PULL_REQUEST_TEMPLATE diff --git a/.github/ISSUE_TEMPLATE/content-bug.md b/.github/ISSUE_TEMPLATE/content-bug.md new file mode 100644 index 000000000000000..bc0f4579ca34822 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/content-bug.md @@ -0,0 +1,33 @@ +--- +name: Content bug +about: "Use this template to notify us of a content bug that needs fixing" +labels: "needs-triage" +assignees: +title: "Content bug: " +--- + +## What page(s) did you find the problem on? + +<!-- include the URL or URLs where you found the problem. If it is a widespread +problem over many pages, just give us a couple of example URLs rather than the +whole lot --> + +## Specific page section or heading? + +<!-- include the specific heading underneath which the problem can be found, if +relevant, to help us locate the problem more easily --> + +## What is the problem? + +<!-- include a description of the problem — is some text misspelt, or +inaccurate? Does an example not work? Is the document missing some information? +Is something just weird? --> + +## What did you expect to see? + +<!-- If you have an idea of what the solution to your problem is, please +provide details here. If you don't know, then that's OK --> + +## Did you test this? If so, how? + +<!-- Please provide any steps you took to test the problem, if appropriate --> diff --git a/.github/ISSUE_TEMPLATE/new-content-suggestion.md b/.github/ISSUE_TEMPLATE/new-content-suggestion.md new file mode 100644 index 000000000000000..e8b9fb58eed3363 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-content-suggestion.md @@ -0,0 +1,27 @@ +--- +name: New content suggestion +about: "Use this template to suggest new larger areas of work that you think the MDN writers should work on" +labels: "Opportunity assessment", +assignees: chrisdavidmills +title: "Content suggestion: <TITLE OF SUGGESTION>" +--- + +## What is the new suggestion? +<!-- include a short description of the content work suggestion --> + +## Why is it important or useful? +<!-- Tell us why the idea is important or useful. Include any information you +can think of that would be useful, for example: + +How many pages are likely to be needed? +What kind of timing would be good for this work? +Will the work enable learners or professionals to achieve their goals better? +Does it address critical needs in the web industry? +Is the work an operational necessity, i.e. is not having it a security risk? +Does the content help make the web more ethical? + --> + +## Other supporting information + +<!-- include any other useful supporting information, such as spec URL, +explainer URL, link to further supporting information --> diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 000000000000000..0a20d04af8113aa --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,6 @@ +Checklist — To help your pull request get merged faster, please do following: + +1. - [ ] Provide a summary of your changes — say what problem you are fixing, what files are changed, what you've done. This doesn't need to be hugely detailed, as we can see exact changes in the "Files changed" tab. +1. - [ ] Provide a link to the issue(s) you are fixing, if appropriate, in the form "Fixes <url-of-issue>". GitHub will render this in the form "Fixes #1234", with the issue number linked to the issue. Doing this allows us to figure out what issues you are fixing, as well as helping to automate things (for example the issue will be closed once the PR that fixed it has been merged). +1. - [ ] Review the results of the automated checking we run on every PR and fix any problems reported (see the list of checks near the bottom of the PR page). If you need help, please ask in a comment! +1. - [ ] Link to any other resources that you think might be useful in reviewing your PR. From f0882627c35a4468d67860eaccd99ac384475acb Mon Sep 17 00:00:00 2001 From: Chris Mills <cmills@mozilla.com> Date: Mon, 8 Mar 2021 10:35:07 +0000 Subject: [PATCH 2/2] clarifying text as per sideshowbarker comment --- .github/ISSUE_TEMPLATE/new-content-suggestion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/new-content-suggestion.md b/.github/ISSUE_TEMPLATE/new-content-suggestion.md index e8b9fb58eed3363..4b6ccb5e9fae523 100644 --- a/.github/ISSUE_TEMPLATE/new-content-suggestion.md +++ b/.github/ISSUE_TEMPLATE/new-content-suggestion.md @@ -14,7 +14,7 @@ title: "Content suggestion: <TITLE OF SUGGESTION>" can think of that would be useful, for example: How many pages are likely to be needed? -What kind of timing would be good for this work? +How much time do you think this work should take? A few hours? A week? A month? Will the work enable learners or professionals to achieve their goals better? Does it address critical needs in the web industry? Is the work an operational necessity, i.e. is not having it a security risk?