Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding issue/pr templates #2906

Merged
merged 2 commits into from
Mar 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/content-bug.md
Original file line number Diff line number Diff line change
@@ -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: <TITLE OF PROBLEM>"
---

## 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 -->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/new-content-suggestion.md
Original file line number Diff line number Diff line change
@@ -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?
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?
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 -->
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -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.