From ca89148abbcce76559e438b1e8a6a99277d4150c Mon Sep 17 00:00:00 2001 From: Matthew Weier O'Phinney Date: Thu, 3 Aug 2017 11:01:49 -0500 Subject: [PATCH 1/2] Renames file containing code of conduct - per https://help.github.com/articles/adding-a-code-of-conduct-to-your-project/ --- CONDUCT.md => CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename CONDUCT.md => CODE_OF_CONDUCT.md (100%) diff --git a/CONDUCT.md b/CODE_OF_CONDUCT.md similarity index 100% rename from CONDUCT.md rename to CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a37665..a9cf904 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -189,4 +189,4 @@ repository, we suggest doing some cleanup of these branches. ## Conduct -Please see our [CONDUCT.md](CONDUCT.md) to understand expected behavior when interacting with others in the project. +Please see our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) to understand expected behavior when interacting with others in the project. From 07178387765e92564874d0d5d33ef7a16965ecd6 Mon Sep 17 00:00:00 2001 From: Matthew Weier O'Phinney Date: Thu, 3 Aug 2017 11:46:26 -0500 Subject: [PATCH 2/2] Adds support files, and moves them under the `docs/` tree. Renames `doc/` to `docs/`, and updates the documentation build rules accordingly (see zendframework/zf-mkdoc-theme#28 for a related change to allow building docs from this location). The `CONTRIBUTING.md` has been moved under this new location. `CONDUCT.md` was renamed to `docs/CODE_OF_CONDUCT.md`. New support files were also added: - `docs/ISSUE_TEMPLATE.md` - `docs/PULL_REQUEST_TEMPLATE.md` - `docs/SUPPORT.md` --- .gitattributes | 2 +- .gitignore | 2 +- README.md | 2 +- CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 docs/ISSUE_TEMPLATE.md | 11 ++++++++ docs/PULL_REQUEST_TEMPLATE.md | 17 +++++++++++++ docs/SUPPORT.md | 25 +++++++++++++++++++ {doc => docs}/book/exception.md | 0 {doc => docs}/book/index.html | 0 {doc => docs}/book/index.md | 0 {doc => docs}/book/intro.md | 0 {doc => docs}/book/middleware.md | 0 {doc => docs}/book/quick-start.md | 0 {doc => docs}/book/response.md | 0 mkdocs.yml | 4 +-- 16 files changed, 58 insertions(+), 5 deletions(-) rename CODE_OF_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/exception.md (100%) rename {doc => docs}/book/index.html (100%) rename {doc => docs}/book/index.md (100%) rename {doc => docs}/book/intro.md (100%) rename {doc => docs}/book/middleware.md (100%) rename {doc => docs}/book/quick-start.md (100%) rename {doc => docs}/book/response.md (100%) diff --git a/.gitattributes b/.gitattributes index 4a5f377..0099bfa 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,4 +1,4 @@ -/doc export-ignore +/docs/book export-ignore /test export-ignore /.gitattributes export-ignore /.gitignore export-ignore diff --git a/.gitignore b/.gitignore index 58cb57e..81c2fc3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -doc/html/ +docs/html/ vendor/ phpunit.xml zf-mkdoc-theme/ diff --git a/README.md b/README.md index 075c0a9..8c98d51 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ $ composer require zendframework/zend-problem-details ## Documentation -Documentation is [in the doc tree](doc/book/), and can be compiled using [mkdocs](http://www.mkdocs.org): +Documentation is [in the doc tree](docs/book/), and can be compiled using [mkdocs](http://www.mkdocs.org): ```bash $ mkdocs build diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_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 0000000..ff8029d --- /dev/null +++ b/docs/ISSUE_TEMPLATE.md @@ -0,0 +1,11 @@ +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 0000000..8859a86 --- /dev/null +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ +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 creating a new feature? + - Why is the new feature needed? What purpose does it serve? + - How will users use 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? diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md new file mode 100644 index 0000000..7655e4c --- /dev/null +++ b/docs/SUPPORT.md @@ -0,0 +1,25 @@ +# Getting Support + +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) +- To report issues, use this repository's + [issue tracker](https://github.com/zendframework/zend-problem-details/issues/new) + +**DO NOT** use the issue tracker to ask questions; use Slack 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/exception.md b/docs/book/exception.md similarity index 100% rename from doc/book/exception.md rename to docs/book/exception.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/intro.md b/docs/book/intro.md similarity index 100% rename from doc/book/intro.md rename to docs/book/intro.md diff --git a/doc/book/middleware.md b/docs/book/middleware.md similarity index 100% rename from doc/book/middleware.md rename to docs/book/middleware.md diff --git a/doc/book/quick-start.md b/docs/book/quick-start.md similarity index 100% rename from doc/book/quick-start.md rename to docs/book/quick-start.md diff --git a/doc/book/response.md b/docs/book/response.md similarity index 100% rename from doc/book/response.md rename to docs/book/response.md diff --git a/mkdocs.yml b/mkdocs.yml index 6e82eed..5f3cd84 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ -docs_dir: doc/book -site_dir: doc/html +docs_dir: docs/book +site_dir: docs/html pages: - index.md - Introduction: intro.md