Permalink
Browse files

docs: update pull request template

  • Loading branch information...
raisedadead committed Oct 11, 2018
1 parent faeaeb8 commit ec3c3a8fc560ecf152581b8986c209a10ad7f01d
Showing with 24 additions and 13 deletions.
  1. +24 −13 .github/PULL_REQUEST_TEMPLATE.md
@@ -15,14 +15,14 @@ Before creating a PR, please make sure to verify the following by marking the ch
### Pre-Submission Checklist
#### Common mandatory requirements
### Common mandatory requirements
- [ ] This pull request targets the `master` branch of freeCodeCamp.
- [ ] Branch starts with either `fix/`, `feature/`, or `translate/`
(e.g. `fix/signin-issue`)
- [ ] Reviewed necessary guidelines in [`CONTRIBUTING.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/CONTRIBUTING.md).
**By submitting this pull request, I have verified the following:**
### By submitting this pull request, I have verified the following:
- [ ] Added descriptive name to pull request. (mandatory)
@@ -41,32 +41,43 @@ Before creating a PR, please make sure to verify the following by marking the ch
fix(coding): add tests to Basic HTML challenge
fix(coding): update instructions to CSS Grid challenge
```
Good Learning platform PR title examples:
```txt
fix(platform): fixed sign in api
fix(platform): removed css from editor
```
### Issues Closures
#### This change is for the Learning platform (UI, logic, etc.) or Coding Challenges, and:
- [ ] I tested my changes by running freeCodeCamp locally.
- [ ] All new and existing tests pass the command `npm test`.
- [ ] Addressed currently open issue. (replace XXXXX with an issue no in next line)
If your pull request touches any files that belong to the api-server or the client's logic, even if its a small typo change, css change, etc. You should build this locally. Your PR may not be accepted, if you did not meet these mandatory requirement.
Closes #XXXXX
#### This change is for Guide Articles, and:
### Since this change is a copy edit or translation for Guide articles or Coding Challenges:
- [ ] I confirm no **plagiarized**, **duplicate**, or **repetitive content** that has been directly copied from another source.
- [ ] I am adding only `https` links to external sources.
- [ ] I am not adding short links instead of full URLs to webpages.
- [ ] I have followed the recomended style guides for the copy edit.
### Issues Closures
### Requirements, for changes which are NOT simple copy editing or translations:
- [ ] Addressed currently open issue. (replace XXXXX with an issue no in next line)
You may skip the below ONLY if your changes do not touch tests, ui logic, api-server, etc. Your PR may not be accepted, if you did not meet these mandatory requirements. Simply put, we can't assume it will work if we never saw it working.
Closes #XXXXX
#### Since this change adds, updates or removes coding challenge tests:
**(Optional) Additional Context and Screenshots:**
- [ ] I completed the coding challenge locally, and the changes look good.
- [ ] Other tests or user stories in instructions are not affected.
#### Since this change is for the Learning platform (UI, logic, etc.):
- [ ] I confirm my changes look good by running freeCodeCamp locally.
- [ ] All new and existing tests pass the command `npm test`.
_(Optional) Additional Context and Screenshots:_
<!-- Add additional context and information below -->

0 comments on commit ec3c3a8

Please sign in to comment.