diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..1c32109248 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,16 @@ +## FreeCodeCamp Issue template +To Use this Template: +* Fill out what you can +* Delete what you do not fill out + +NOTE: ISSUES ARE NOT FOR CODE HELP - Ask for Help at https://gitter.im/FreeCodeCamp/Help + +## Issue Description +* When Issue Happens +* Steps To Reproduce + +## Browser Information +* Browser Name, Version +* Operating System + +## Screenshot diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..e1564eb1f0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +## FreeCodeCamp Pull Request template +Please, go through steps before you submit a PR. + +1. Make sure that your PR is not a duplicate. +2. If not then: + + 2.1. Make sure you've done your changes in a separate branch, like `fix/signin-issue` or `feature/issue-templates`. + + 2.2. You have a descriptive commit message. + + 2.3. You have only one commit (if not, [squash](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/git-rebase#squashing-multiple-commits-into-one) them into one commit). + + 2.4. Make sure `npm test` doesn't throw any error. If it does, fix them first and amend your commit. + +3. **After** these steps you're ready to open a pull request. ***Don't*** forget to remove this template first. + + 3.1. Give a descriptive title to your PR. + + 3.2. Provide a description of your changes. + + 3.3. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). diff --git a/README.md b/README.md index c4f3652ff3..5295b62f74 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Do not file an issue until you have followed these steps: Contributing ------------ -We welcome pull requests from Free Code Camp campers (our students) and seasoned JavaScript developers alike! Please, follow [these steps](CONTRIBUTING.md) to contribute. +We welcome pull requests from Free Code Camp campers (our students) and seasoned JavaScript developers alike! Please, follow [these steps](.github/CONTRIBUTING.md) to contribute. License -------