Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/doc export-ignore
/docs/book export-ignore
/test export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
doc/html/
docs/html/
vendor/
phpunit.xml
zf-mkdoc-theme/
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md → docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
11 changes: 11 additions & 0 deletions docs/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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

17 changes: 17 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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?
25 changes: 25 additions & 0 deletions docs/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down