greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update pull request template

pull/18317/merge
mrugesh mohapatra 2018-10-11 21:49:01 +05:30 committed by GitHub
parent faeaeb8bad
commit ec3c3a8fc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -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
```
#### 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`.
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.
#### This change is for Guide Articles, and:
- [ ] 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.
### Issues Closures
- [ ] Addressed currently open issue. (replace XXXXX with an issue no in next line)
Closes #XXXXX
**(Optional) Additional Context and Screenshots:**
### 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.
### Requirements, for changes which are NOT simple copy editing or translations:
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.
#### Since this change adds, updates or removes coding challenge tests:
- [ ] 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 -->