Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.

Commit a003368

Browse files
committed
Prepare documentation and support docs
- Renamed `doc/` to `docs/`, to allow pushing support docs into that tree. - Renamed `CONDUCT.md` to `CODE_OF_CONDUCT.md`. - Added PR and issue templates. - Added `SUPPORT.md`.
1 parent 42a3acf commit a003368

18 files changed

+75
-15
lines changed

.gitattributes

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/doc export-ignore
1+
/docs export-ignore
22
/test export-ignore
33
/.gitattributes export-ignore
44
/.gitignore export-ignore

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
doc/html/
1+
docs/html/
22
vendor/
33
phpunit.xml
44
zf-mkdoc-theme/

composer.json

+11-1
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,24 @@
44
"type": "library",
55
"license": "BSD-3-Clause",
66
"keywords": [
7+
"expressive",
78
"hal",
89
"http",
910
"psr",
1011
"psr-7",
1112
"psr-11",
1213
"psr-13",
13-
"rest"
14+
"rest",
15+
"zf",
16+
"zendframework"
1417
],
18+
"support": {
19+
"docs": "https://docs.zendframework.com/zend-expressive-hal/",
20+
"issues": "https://github.com/zendframework/zend-expressive-hal/issues",
21+
"source": "https://github.com/zendframework/zend-expressive-hal",
22+
"slack": "https://zendframework-slack.herokuapp.com",
23+
"forum": "https://discourse.zendframework.com/c/questions/expressive"
24+
},
1525
"config": {
1626
"sort-packages": true
1727
},

CONDUCT.md docs/CODE_OF_CONDUCT.md

File renamed without changes.

CONTRIBUTING.md docs/CONTRIBUTING.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@
55
If you wish to contribute to this project, please be sure to
66
read/subscribe to the following resources:
77

8-
- [Coding Standards](https://github.com/zendframework/zend-coding-standard)
9-
- [Forums](https://discourse.zendframework.com/c/contributors)
10-
- [Slack](https://zendframework-slack.herokuapp.com)
8+
- [Coding Standards](https://github.com/zendframework/zend-coding-standard)
9+
- [Forums](https://discourse.zendframework.com/c/contributors)
10+
- [Slack](https://zendframework-slack.herokuapp.com)
11+
- [Code of Conduct](CODE_OF_CONDUCT.md)
1112

12-
If you are working on new features or refactoring [create a
13-
proposal](https://github.com/zendframework/zend-expressive-hal/issues/new).
13+
If you are working on new features or refactoring
14+
[create a proposal](https://github.com/zendframework/zend-expressive-hal/issues/new).
1415

1516
## RUNNING TESTS
1617

@@ -155,7 +156,7 @@ To send a pull request, you have two options.
155156
If using GitHub, you can do the pull request from there. Navigate to
156157
your repository, select the branch you just created, and then select the
157158
"Pull Request" button in the upper right. Select the user/organization
158-
"zendframework" as the recipient.
159+
"zendframework" (or whatever the upstream organization is) as the recipient.
159160

160161
#### What branch to issue the pull request against?
161162

@@ -186,7 +187,3 @@ repository, we suggest doing some cleanup of these branches.
186187
```console
187188
$ git push {username} :<branchname>
188189
```
189-
190-
## Conduct
191-
192-
Please see our [CONDUCT.md](CONDUCT.md) to understand expected behavior when interacting with others in the project.

docs/ISSUE_TEMPLATE.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Provide a narrative description of what you are trying to accomplish.
2+
3+
### Code to reproduce the issue
4+
5+
```php
6+
```
7+
8+
### Expected results
9+
10+
### Actual results
11+

docs/PULL_REQUEST_TEMPLATE.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Provide a narrative description of what you are trying to accomplish:
2+
3+
- Are you fixing a bug?
4+
- Detail how the bug is invoked currently.
5+
- Detail the original, incorrect behavior.
6+
- Detail the new, expected behavior.
7+
8+
- Are you creating a new feature?
9+
- Why is the new feature needed? What purpose does it serve?
10+
- How will users use the new feature?
11+
12+
- Is this related to quality assurance?
13+
- Detail why the changes are necessary.
14+
15+
- Is this related to documentation?
16+
- Is it a typographical and/or grammatical fix?
17+
- Is it new documentation?

docs/SUPPORT.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Getting Support
2+
3+
Zend Framework offers three support channels:
4+
5+
- For real-time questions, use our
6+
[Slack](https://zendframework-slack.herokuapp.com)
7+
- For detailed questions (e.g., those requiring examples) use our
8+
[forums](https://discourse.zendframework.com/c/contributors)
9+
- To report issues, use this repository's
10+
[issue tracker](https://github.com/{org}/{repo}/issues/new)
11+
12+
**DO NOT** use the issue tracker to ask questions; use Slack or the forums for
13+
that. Questions posed to the issue tracker will be closed.
14+
15+
When reporting an issue, please include the following details:
16+
17+
- A narrative description of what you are trying to accomplish.
18+
- The minimum code necessary to reproduce the issue.
19+
- The expected results of exercising that code.
20+
- The actual results received.
21+
22+
We may ask for additional details: what version of the library you are using,
23+
and what PHP version was used to reproduce the issue.
24+
25+
You may also submit a failing test case as a pull request.
File renamed without changes.

doc/book/hal.md docs/book/hal.md

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.

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
docs_dir: doc/book
2-
site_dir: doc/html
1+
docs_dir: docs/book
2+
site_dir: docs/html
33
pages:
44
- index.md
55
- Introduction: intro.md

0 commit comments

Comments
 (0)