gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update issue and PR templates

Browse Source
This commit is contained in:
Mrugesh Mohapatra
2018-10-11 17:16:04 +05:30
parent 09f0893a2e
commit 995d720b33
2 changed files with 55 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,18 +0,0 @@
<!-- NOTE: If you're reporting a security issue, don't create a GitHub issue. Instead, email security@freecodecamp.org. We will look into it immediately. -->
#### Describe your problem and - if possible - how to reproduce it
#### Add a Link to the page with the problem
#### Tell us about your browser and operating system
* Browser Name:
* Browser Version:
* Operating System:
#### If possible, add a screenshot here

80
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,32 +1,62 @@
<!-- freeCodeCamp Pull Request Template -->
<!-- IMPORTANT
<!-- IMPORTANT Please review https://github.com/freeCodeCamp/freeCodeCamp/blob/staging/CONTRIBUTING.md for detailed contributing guidelines -->
<!-- Help with PRs can be found at https://gitter.im/FreeCodeCamp/Contributors -->
<!-- Make sure that your PR is not a duplicate -->
Before creating a PR, please make sure to verify the following by marking the checkboxes below as complete.
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply. -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] Your pull request targets the `staging` branch of freeCodeCamp.
- [ ] Branch starts with either `fix/`, `feature/`, or `translate/` (e.g. `fix/signin-issue`)
- [ ] You have only one commit (if not, [squash](http://forum.freecodecamp.org/t/how-to-squash-multiple-commits-into-one-with-git/13231) them into one commit).
- [ ] All new and existing tests pass the command `npm test`. Use `git commit --amend` to amend any fixes.
- [x] Like this!
#### Type of Change
<!-- What type of change does your code introduce? After creating the PR, tick the checkboxes that apply. -->
- [ ] Small bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
- [ ] Add new translation (feature adding new translations)
-->
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply. -->
<!-- If you're unsure about any of these, don't hesitate to ask in the Contributors room linked above. We're here to help! -->
- [ ] Tested changes locally.
- [ ] Addressed currently open issue (replace XXXXX with an issue no in next line)
### Description
<!-- Add a description of the change you are making, this will help reviewers in the QA process. -->
### Pre-Submission Checklist
**By submitting this pull request, I have verified the following:**
- [ ] Added descriptive name to pull request.
Your PR should NOT be called `Update index.md`, since it does not help the maintainer understand what has been changed.
Good Guide PR title examples:
```txt
fix(guide): Git - edit Git Commit article
feat(guide): PHP - create PHP section and add Data Structures article
```
Good Coding challenge PR title examples:
```txt
fix(coding): add tests to Basic HTML challenge
fix(coding): update instructions to CSS Grid challenge
```
#### This change is for the Learning platform or Coding Challenges, and:
- [ ] I tested my changes by running freeCodeCamp locally.
- [ ] All new and existing tests pass the command `npm test`.
#### 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.
#### Common requirements
- [ ] This pull request targets the `master` branch of freeCodeCamp.
- [ ] Branch starts with either `fix/`, `feature/`, or `translate/`
(e.g. `fix/signin-issue`)
- [ ] I reviewed necessary formatting guidelines in [`CONTRIBUTING.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/CONTRIBUTING.md).
### Issues Closures
- [ ] Addressed currently open issue. (replace XXXXX with an issue no in next line)
Closes #XXXXX
#### Description
<!-- Describe your changes in detail -->
**(Optional) Additional Context and Screenshots:**
<!-- Add additional context and information below -->