Merge pull request #23 from webimpress/hotfix/docs

Rebase doc templates

Author: weierophinney

.gitattributes

@@ -1,10 +1,10 @@
-/docs export-ignore
-/test export-ignore
 /.coveralls.yml export-ignore
 /.gitattributes export-ignore
 /.gitignore export-ignore
 /.travis.yml export-ignore
 /composer.lock export-ignore
+/docs/ export-ignore
 /mkdocs.yml export-ignore
 /phpcs.xml export-ignore
 /phpunit.xml.dist export-ignore
+/test/ export-ignore

.gitignore

@@ -1,7 +1,7 @@
-docs/html/
-vendor/
-phpunit.xml
-zf-mkdoc-theme/
-clover.xml
-coveralls-upload.json
-zf-mkdoc-theme.tgz
+/clover.xml
+/coveralls-upload.json
+/docs/html/
+/phpunit.xml
+/vendor/
+/zf-mkdoc-theme.tgz
+/zf-mkdoc-theme/

.travis.yml

@@ -5,7 +5,6 @@ language: php
 cache:
   directories:
     - $HOME/.composer/cache
-    - vendor
 
 env:
   global:
@@ -34,19 +33,16 @@ matrix:
     - php: 7.2
       env:
         - DEPS=latest
-  allow_failures:
-    - php: 7.2
 
 before_install:
   - if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
-  - travis_retry composer self-update
 
 install:
-  - travis_retry composer install $COMPOSER_ARGS --ignore-platform-reqs
+  - travis_retry composer install $COMPOSER_ARGS
   - if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi
   - if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable $COMPOSER_ARGS ; fi
   - if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer require --dev $COMPOSER_ARGS $COVERAGE_DEPS ; fi
-  - composer show
+  - stty cols 120 && composer show
 
 script:
   - if [[ $TEST_COVERAGE == 'true' ]]; then composer test-coverage ; else composer test ; fi

composer.json

@@ -1,7 +1,6 @@
 {
     "name": "zendframework/zend-problem-details",
     "description": "Problem Details for PSR-7 HTTP APIs",
-    "type": "library",
     "license": "BSD-3-Clause",
     "keywords": [
         "api",
@@ -14,12 +13,10 @@
         "docs": "https://docs.zendframework.com/zend-problem-details/",
         "issues": "https://github.com/zendframework/zend-problem-details/issues",
         "source": "https://github.com/zendframework/zend-problem-details",
+        "rss": "https://github.com/zendframework/zend-problem-details/releases.atom",
         "slack": "https://zendframework-slack.herokuapp.com",
         "forum": "https://discourse.zendframework.com/c/questions/expressive"
     },
-    "config": {
-        "sort-packages": true
-    },
     "require": {
         "php": "^7.1",
         "ext-json": "*",
@@ -45,9 +42,15 @@
             "ZendTest\\ProblemDetails\\": "test/"
         }
     },
+    "config": {
+        "sort-packages": true
+    },
     "extra": {
         "zf": {
             "config-provider": "Zend\\ProblemDetails\\ConfigProvider"
+        },
+        "branch-alias": {
+            "dev-master": "1.0-dev"
         }
     },
     "scripts": {

docs/CONTRIBUTING.md

@@ -5,9 +5,10 @@
 If you wish to contribute to this project, please be sure to
 read/subscribe to the following resources:
 
- -  [Coding Standards](https://github.com/zendframework/zend-coding-standard)
- -  [Forums](https://discourse.zendframework.com/c/contributors)
- -  [Slack](https://zendframework-slack.herokuapp.com)
+ - [Coding Standards](https://github.com/zendframework/zend-coding-standard)
+ - [Forums](https://discourse.zendframework.com/c/contributors)
+ - [Slack](https://zendframework-slack.herokuapp.com)
+ - [Code of Conduct](CODE_OF_CONDUCT.md)
 
 If you are working on new features or refactoring
 [create a proposal](https://github.com/zendframework/zend-problem-details/issues/new).
@@ -155,7 +156,7 @@ To send a pull request, you have two options.
 If using GitHub, you can do the pull request from there. Navigate to
 your repository, select the branch you just created, and then select the
 "Pull Request" button in the upper right. Select the user/organization
-"zendframework" as the recipient.
+"zendframework" (or whatever the upstream organization is) as the recipient.
 
 #### What branch to issue the pull request against?
 
@@ -186,7 +187,3 @@ repository, we suggest doing some cleanup of these branches.
    ```console
    $ git push {username} :<branchname>
    ```
-
-## Conduct
-
-Please see our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) to understand expected behavior when interacting with others in the project.

docs/ISSUE_TEMPLATE.md

@@ -1,11 +1,19 @@
+ - [ ] I was not able to find an [open](https://github.com/zendframework/zend-problem-details/issues?q=is%3Aopen) or [closed](https://github.com/zendframework/zend-problem-details/issues?q=is%3Aclosed) issue matching what I'm seeing.
+ - [ ] This is not a question. (Questions should be asked on [slack](https://zendframework.slack.com/) ([Signup for Slack 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

@@ -1,17 +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.
+- [ ] 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?
+- [ ] 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 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?
+- [ ] Is this related to documentation?
+  <!-- Is it a typographical and/or grammatical fix? -->
+  <!-- Is it new documentation? -->

docs/SUPPORT.md

@@ -5,7 +5,7 @@ Zend Framework offers three support channels:
 - For real-time questions, use our
   [Slack](https://zendframework-slack.herokuapp.com)
 - For detailed questions (e.g., those requiring examples) use our
-  [forums](https://discourse.zendframework.com/c/contributors)
+  [forums](https://discourse.zendframework.com/c/questions/expressive)
 - To report issues, use this repository's
   [issue tracker](https://github.com/zendframework/zend-problem-details/issues/new)