diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 98% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index 878f6eeffc..6431b4efad 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,7 +1,8 @@ # Contributing to HTML5 Boilerplate ♥ [HTML5 Boilerplate](https://html5boilerplate.com/) and want to get involved? -Thanks! There are plenty of ways you can help! +Thanks! We're actively looking for folks interested in helping out and there +are plenty of ways you can help! Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..2f02c0a7e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,74 @@ +**I'm submitting a ...** + +- [ ] bug report +- [ ] feature request +- [ ] other (Please do not submit support requests here (below)) + +## Notes: + +* Please **do not** use the issue tracker for personal support requests (use + [Stack Overflow](https://stackoverflow.com/questions/tagged/html5boilerplate)). + +* Please **do not** derail or troll issues. Keep the discussion on topic and + respect the opinions of others. + +* Please **do not** open issues or pull requests regarding the code in + [`.htaccess`](https://github.com/h5bp/server-configs-apache), + [`jQuery`](https://github.com/jquery/jquery/), + [`Modernizr`](https://github.com/Modernizr/Modernizr) or + [`Normalize.css`](https://github.com/necolas/normalize.css) (open them in + their respective repositories). + +## Bug reports + +A bug is a _demonstrable problem_ that is caused by the code in the repository. +Good bug reports are extremely helpful - thank you! + +Guidelines for bug reports: + +1. **Use the GitHub issue search** — check if the issue has already been + reported. + + We have a long history of sometimes _very_ detailed discussion of every line of code + in the project. We want discussion, so it might still warrant an issue. It + just helps to get the (sometimes extensive) context. + +2. **Check if the issue has been fixed** — try to reproduce it using the + latest `master` or development branch in the repository. + +3. **Isolate the problem** — ideally create a [reduced test + case](https://css-tricks.com/reduced-test-cases/) and a live example. + +A good bug report shouldn't leave others needing to chase you up for more +information. Please try to be as detailed as possible in your report. What is +your environment? What steps will reproduce the issue? What browser(s) and OS +experience the problem? What would you expect to be the outcome? All these +details will help people to fix any potential bugs. + +Example: + +> Short and descriptive example bug report title +> +> A summary of the issue and the browser/OS environment in which it occurs. If +> suitable, include the steps required to reproduce the bug. +> +> 1. This is the first step +> 2. This is the second step +> 3. Further steps, etc. +> +> `` - a link to the reduced test case +> +> Any other information you want to share that is relevant to the issue being +> reported. This might include the lines of code that you have identified as +> causing the bug, and potential solutions (and your opinions on their +> merits). + + +## Feature requests + +Feature requests are welcome. But take a moment to find out whether your idea +fits with the scope and aims of the project. It's up to *you* to make a strong +case to convince the project's developers of the merits of this feature. Please +provide as much detail and context as possible. + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..78581fdb6b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. + + +