Merge branch 'hotfix/247'

Close #247

CHANGELOG.md

@@ -10,7 +10,12 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Changed
 
-- Nothing.
+- [#246](https://github.com/zendframework/zend-expressive-skeleton/pull/246)
+  moves contributing documentation into the `docs/` tree, and adds more
+  documentation for that context (support document, issue and pull request
+  templates). These changes also allow a simplified mechanism for removing these
+  from the tree after initial install, allowing users to define appropriate
+  versions for their own project.
 
 ### Deprecated
 

README.md

@@ -3,11 +3,11 @@
 [![Build Status](https://secure.travis-ci.org/zendframework/zend-expressive-skeleton.svg?branch=master)](https://secure.travis-ci.org/zendframework/zend-expressive-skeleton)
 [![Coverage Status](https://coveralls.io/repos/github/zendframework/zend-expressive-skeleton/badge.svg?branch=master)](https://coveralls.io/github/zendframework/zend-expressive-skeleton?branch=master)
 
-*Begin developing PSR-7 middleware applications in seconds!*
+*Begin developing PSR-15 middleware applications in seconds!*
 
 [zend-expressive](https://github.com/zendframework/zend-expressive) builds on
 [zend-stratigility](https://github.com/zendframework/zend-stratigility) to
-provide a minimalist PSR-7 middleware framework for PHP with routing, DI
+provide a minimalist PSR-15 middleware framework for PHP with routing, DI
 container, optional templating, and optional error handling capabilities.
 
 This installer will setup a skeleton application based on zend-expressive by
@@ -147,4 +147,4 @@ $ composer test
 Please note that the installer tests remove installed config files and templates
 before and after running the tests.
 
-Before contributing read [the contributing guide](CONTRIBUTING.md).
+Before contributing read [the contributing guide](docs/CONTRIBUTING.md).

composer.json

@@ -36,7 +36,7 @@
         "issues": "https://github.com/zendframework/zend-expressive-skeleton/issues",
         "source": "https://github.com/zendframework/zend-expressive-skeleton",
         "rss": "https://github.com/zendframework/zend-expressive-skeleton/releases.atom",
-        "slack": "https://zendframework-slack.herokuapp.com",
+        "chat": "https://zendframework-slack.herokuapp.com",
         "forum": "https://discourse.zendframework.com/c/questions/expressive"
     },
     "require": {

docs/ISSUE_TEMPLATE.md

@@ -0,0 +1,20 @@
+ - [ ] I was not able to find an [open](https://github.com/zendframework/zend-expressive-skeleton/issues?q=is%3Aopen) or [closed](https://github.com/zendframework/zend-expressive-skeleton/issues?q=is%3Aclosed) issue matching what I'm seeing.
+ - [ ] This is not a question. (Questions should be asked on [chat](https://zendframework.slack.com/) ([Signup for here](https://zendframework-slack.herokuapp.com/)) or our [forums](https://discourse.zendframework.com/).)
+
+Provide a narrative description of what you are trying to accomplish.
+
+### Code to reproduce the issue
+
+<!-- Please provide the minimum code necessary to recreate the issue -->
+
+```php
+
+```
+
+### Expected results
+
+<!-- What do you think should have happened? -->
+
+### Actual results
+
+<!-- What did you actually observe? -->

docs/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+Provide a narrative description of what you are trying to accomplish:
+
+- [ ] Are you fixing a bug?
+  - [ ] Detail how the bug is invoked currently.
+  - [ ] Detail the original, incorrect behavior.
+  - [ ] Detail the new, expected behavior.
+  - [ ] Base your feature on the `master` branch, and submit against that branch.
+  - [ ] Add a regression test that demonstrates the bug, and proves the fix.
+  - [ ] Add a `CHANGELOG.md` entry for the fix.
+
+- [ ] Are you creating a new feature?
+  - [ ] Why is the new feature needed? What purpose does it serve?
+  - [ ] How will users use the new feature?
+  - [ ] Base your feature on the `develop` branch, and submit against that branch.
+  - [ ] Add only one feature per pull request; split multiple features over multiple pull requests
+  - [ ] Add tests for the new feature.
+  - [ ] Add documentation for the new feature.
+  - [ ] Add a `CHANGELOG.md` entry for the new feature.
+
+- [ ] Is this related to quality assurance?
+  <!-- Detail why the changes are necessary -->
+
+- [ ] Is this related to documentation?
+  <!-- Is it a typographical and/or grammatical fix? -->
+  <!-- Is it new documentation? -->

docs/SUPPORT.md

@@ -0,0 +1,25 @@
+# Getting Support
+
+Zend Framework offers three support channels:
+
+- For real-time questions, use our
+  [chat](https://zendframework-slack.herokuapp.com)
+- For detailed questions (e.g., those requiring examples) use our
+  [forums](https://discourse.zendframework.com/c/questions/{category})
+- To report issues, use this repository's
+  [issue tracker](https://github.com/zendframework/zend-expressive-skeleton/issues/new)
+
+**DO NOT** use the issue tracker to ask questions; use chat or the forums for
+that. Questions posed to the issue tracker will be closed.
+
+When reporting an issue, please include the following details:
+
+- A narrative description of what you are trying to accomplish.
+- The minimum code necessary to reproduce the issue.
+- The expected results of exercising that code.
+- The actual results received.
+
+We may ask for additional details: what version of the library you are using,
+and what PHP version was used to reproduce the issue.
+
+You may also submit a failing test case as a pull request.

src/ExpressiveInstaller/OptionalPackages.php

@@ -63,8 +63,6 @@ class OptionalPackages
         '.coveralls.yml',
         '.travis.yml',
         'CHANGELOG.md',
-        'CONDUCT.md',
-        'CONTRIBUTING.md',
         'phpcs.xml',
         'phpstan.installer.neon',
         'src/App/templates/.gitkeep',
@@ -570,6 +568,7 @@ private function cleanUp() : void
 
         $this->recursiveRmdir($this->installerSource);
         $this->recursiveRmdir($this->projectRoot . 'test/ExpressiveInstallerTest');
+        $this->recursiveRmdir($this->projectRoot . 'docs');
 
         $this->preparePhpunitConfig();
     }