Browse Source

Merge pull request #8300 from cakephp/github-templates

GitHub templates
ADmad 10 years ago
parent
commit
70b19a309c
3 changed files with 23 additions and 0 deletions
  1. 0 0
      .github/CONTRIBUTING.md
  2. 18 0
      .github/ISSUE_TEMPLATE.md
  3. 5 0
      .github/PULL_REQUEST_TEMPLATE.md

CONTRIBUTING.md → .github/CONTRIBUTING.md


+ 18 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+#### Preamble
+This is a (multiple allowed):
+* [x] bug
+* [ ] enhancement
+* [ ] feature-discussion (RFC)
+
+## DESCRIPTIVE TITLE HERE
+CakePHP Version: EXACT RELEASE VERSION OR COMMIT HASH, HERE.
+Platform and Target: YOUR WEB-SERVER, DATABASE AND OTHER RELEVANT INFO AND HOW THE REQUEST IS BEING MADE, HERE.
+
+### What you did
+EXPLAIN WHAT YOU DID, PREFERABLY WITH CODE EXAMPLES, HERE.
+
+### Expected Behavior
+EXPLAIN WHAT IS TO BE EXPECTED, HERE.
+
+### Actual Behavior
+EXPLAIN WHAT IS ACTUALLY HAPPENING, HERE.

+ 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.