Browse Source

Add draft templates for github issues and pull requests.

ADmad 10 years ago
parent
commit
fd1d5579ca
2 changed files with 20 additions and 0 deletions
  1. 15 0
      .github/ISSUE_TEMPLATE.md
  2. 5 0
      .github/PULL_REQUEST_TEMPLATE.md

+ 15 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+Remember, an issue is not the place to ask questions. You can use [Stack Overflow](http://stackoverflow.com/questions/tagged/cakephp) for that.
+
+Before you open an issue, please check if a similar issue already exists or has been closed before.
+
+### When reporting a bug, please be sure to include the following:
+- [ ] A descriptive title
+- [ ] What version of CakePHP you're using, and the platform(s) you're running it on
+- [ ] The behavior you expect to see, and the actual behavior
+- [ ] An *isolated* way to reproduce the behavior
+
+### When you open an issue for a feature request, please add as much detail as possible:
+- [ ] A descriptive title
+- [ ] A description of the problem you're trying to solve, including *why* you think this is a problem
+- [ ] An overview of the suggested solution
+- [ ] If the feature changes current behavior, reasons why your solution is better

+ 5 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+
+The best way to propose a feature is to open an issue first and discuss your ideas there before implementing them.
+
+Always follow the [contribution guidelines](https://github.com/cakephp/cakephp/blob/master/.github/CONTRIBUTING.md) when submitting a pull request. In particular, make sure existing tests still pass, and add tests for all new behavior. When fixing a bug, you may want to add a test to verify the fix.