chore: issue/pr template

adhocore · Aug 21, 2018 · 88e47a2 · 88e47a2
1 parent 286e7a8
commit 88e47a2
Show file tree

Hide file tree

Showing 2 changed files with 148 additions and 0 deletions.
diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md
@@ -0,0 +1,98 @@
+## This is a
+
+<-- Put a cross `x` in one of the below boxes -->
+
+- [ ] Bug/Issue
+- [ ] Feature request
+- [ ] General stuff
+
+<!-- BugStart (Remove this line if reporting bug)
+## Describe the bug/issue
+
+I wanted to ...
+
+### What happened
+
+...
+
+### What is expected
+
+...
+
+### Reproduction steps
+
+- ...
+
+### Sample code
+
+
+### Environment
+
+- OS:
+- PHP version:
+- phint version:
+
+BugEnd (Remove this line if reporting bug) -->
+
+<!-- FeatureStart (Remove this line if requesting feature)
+## Explain the feature
+
+
+FeatureEnd (Remove this line if requesting feature) -->
+
+<!-- GeneralStart (Remove this line if it is general concern)
+## Explain yourself
+
+...
+
+GeneralEnd (Remove this line if it is general concern) -->
+
+---
+## This is a
+
+<-- Put a cross `x` in one of the below boxes -->
+
+- [ ] Bug/Issue
+- [ ] Feature request
+- [ ] General stuff
+
+<!-- BugStart (Remove this line if reporting bug)
+## Describe the bug/issue
+
+I wanted to ...
+
+### What happened
+
+...
+
+### What is expected
+
+...
+
+### Reproduction steps
+
+- ...
+
+### Sample code
+
+
+### Environment
+
+- OS:
+- PHP version:
+- phint version:
+
+BugEnd (Remove this line if reporting bug) -->
+
+<!-- FeatureStart (Remove this line if requesting feature)
+## Explain the feature
+
+
+FeatureEnd (Remove this line if requesting feature) -->
+
+<!-- GeneralStart (Remove this line if it is general concern)
+## Explain yourself
+
+...
+
+GeneralEnd (Remove this line if it is general concern) -->
diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,50 @@
+## This is a
+
+<-- Put a cross `x` in relevant boxes below -->
+
+- [ ] New feature
+- [ ] Fix for ... <!-- (the issue/bug) -->
+- [ ] General improvement
+- [ ] Backward incompatible change
+
+It closes # <!-- (Put the issue number after `#`) -->
+
+## Describe the change
+
+...
+
+## How to use it
+
+...
+
+#### Sample code
+
+```php
+
+```
+
+---
+## This is a
+
+<-- Put a cross `x` in relevant boxes below -->
+
+- [ ] New feature
+- [ ] Fix for ... <!-- (the issue/bug) -->
+- [ ] General improvement
+- [ ] Backward incompatible change
+
+It closes # <!-- (Put the issue number after `#`) -->
+
+## Describe the change
+
+...
+
+## How to use it
+
+...
+
+#### Sample code
+
+```php
+
+```