From ec257daa04316a7390c01d134b5e108ee2682480 Mon Sep 17 00:00:00 2001 From: Matthew Weier O'Phinney Date: Thu, 6 Sep 2018 09:24:04 -0500 Subject: [PATCH] Rename doc/ to docs/ All new components and most existing components now use the `docs/` tree, which is recognized by GitHub as a location for both documentation and GitHub project templates (code of conduct, contribution guide, issue and pull request templates, support docs, etc.). This patch renames the `doc/` directory to `docs/`, and adds in missing templates. It also updates the project `README.md` to reflect reality. --- README.md | 8 +++++--- CONDUCT.md => docs/CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 docs/ISSUE_TEMPLATE.md | 19 ++++++++++++++++++ docs/PULL_REQUEST_TEMPLATE.md | 25 ++++++++++++++++++++++++ docs/SUPPORT.md | 25 ++++++++++++++++++++++++ {doc => docs}/book/api.md | 0 {doc => docs}/book/custom-responses.md | 0 {doc => docs}/book/emitting-responses.md | 0 {doc => docs}/book/factories.md | 0 {doc => docs}/book/index.html | 0 {doc => docs}/book/index.md | 0 {doc => docs}/book/install.md | 0 {doc => docs}/book/overview.md | 0 {doc => docs}/book/serialization.md | 0 {doc => docs}/book/usage.md | 0 16 files changed, 74 insertions(+), 3 deletions(-) rename CONDUCT.md => docs/CODE_OF_CONDUCT.md (100%) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) create mode 100644 docs/ISSUE_TEMPLATE.md create mode 100644 docs/PULL_REQUEST_TEMPLATE.md create mode 100644 docs/SUPPORT.md rename {doc => docs}/book/api.md (100%) rename {doc => docs}/book/custom-responses.md (100%) rename {doc => docs}/book/emitting-responses.md (100%) rename {doc => docs}/book/factories.md (100%) rename {doc => docs}/book/index.html (100%) rename {doc => docs}/book/index.md (100%) rename {doc => docs}/book/install.md (100%) rename {doc => docs}/book/overview.md (100%) rename {doc => docs}/book/serialization.md (100%) rename {doc => docs}/book/usage.md (100%) diff --git a/README.md b/README.md index fadb18c2..431fa0f7 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ Develop: This package supercedes and replaces [phly/http](https://github.com/phly/http). -`zend-diactoros` is a PHP package containing implementations of the [accepted PSR-7 HTTP message interfaces](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-7-http-message.md), as well as a "server" implementation similar to [node's http.Server](http://nodejs.org/api/http.html). +`zend-diactoros` is a PHP package containing implementations of the +[PSR-7 HTTP message interfaces](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-7-http-message.md) +and [PSR-17 HTTP message factory interfaces](https://www.php-fig.org/psr/psr-17). * File issues at https://github.com/zendframework/zend-diactoros/issues * Issue patches to https://github.com/zendframework/zend-diactoros/pulls @@ -20,9 +22,9 @@ This package supercedes and replaces [phly/http](https://github.com/phly/http). Documentation is available at: -- https://zendframework.github.io/zend-diactoros/ +- https://docs.zendframework.com/zend-diactoros/ -Source files for documentation are [in the doc/ tree](doc/). +Source files for documentation are [in the docs/ tree](docs/). [Master]: https://travis-ci.org/zendframework/zend-diactoros [Master image]: https://secure.travis-ci.org/zendframework/zend-diactoros.svg?branch=master diff --git a/CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..5652afb0 --- /dev/null +++ b/docs/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ + - [ ] I was not able to find an [open](https://github.com/zendframework/zend-diactoros/issues?q=is%3Aopen) or [closed](https://github.com/zendframework/zend-diactoros/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 here](https://zendframework-slack.herokuapp.com/)) or our [forums](https://discourse.zendframework.com/c/questions/expressive).) + +Provide a narrative description of what you are trying to accomplish. + +### Code to reproduce the issue + + + +```php +``` + +### Expected results + + + +### Actual results + + diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..f00d90c0 --- /dev/null +++ b/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? + + +- [ ] Is this related to documentation? + + diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md new file mode 100644 index 00000000..87ca260d --- /dev/null +++ b/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/expressive) +- To report issues, use this repository's + [issue tracker](https://github.com/zendframework/zend-diactoros/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. diff --git a/doc/book/api.md b/docs/book/api.md similarity index 100% rename from doc/book/api.md rename to docs/book/api.md diff --git a/doc/book/custom-responses.md b/docs/book/custom-responses.md similarity index 100% rename from doc/book/custom-responses.md rename to docs/book/custom-responses.md diff --git a/doc/book/emitting-responses.md b/docs/book/emitting-responses.md similarity index 100% rename from doc/book/emitting-responses.md rename to docs/book/emitting-responses.md diff --git a/doc/book/factories.md b/docs/book/factories.md similarity index 100% rename from doc/book/factories.md rename to docs/book/factories.md diff --git a/doc/book/index.html b/docs/book/index.html similarity index 100% rename from doc/book/index.html rename to docs/book/index.html diff --git a/doc/book/index.md b/docs/book/index.md similarity index 100% rename from doc/book/index.md rename to docs/book/index.md diff --git a/doc/book/install.md b/docs/book/install.md similarity index 100% rename from doc/book/install.md rename to docs/book/install.md diff --git a/doc/book/overview.md b/docs/book/overview.md similarity index 100% rename from doc/book/overview.md rename to docs/book/overview.md diff --git a/doc/book/serialization.md b/docs/book/serialization.md similarity index 100% rename from doc/book/serialization.md rename to docs/book/serialization.md diff --git a/doc/book/usage.md b/docs/book/usage.md similarity index 100% rename from doc/book/usage.md rename to docs/book/usage.md