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

Commit 8ce5e7b

Browse files
committed
All support files in docs directory - updated and added missing templates
1 parent cfa9fa5 commit 8ce5e7b

File tree

6 files changed

+71
-55
lines changed

6 files changed

+71
-55
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/docs export-ignore
12
/test export-ignore
23
.coveralls.yml
34
.gitattributes export-ignore

CONDUCT.md renamed to docs/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributor Code of Conduct
22

3-
The Zend Framework project adheres to [The Code Manifesto](http://codemanifesto.com)
3+
This project adheres to [The Code Manifesto](http://codemanifesto.com)
44
as its guidelines for contributor interactions.
55

66
## The Code Manifesto

CONTRIBUTING.md renamed to docs/CONTRIBUTING.md

Lines changed: 8 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,16 @@
22

33
## RESOURCES
44

5-
If you wish to contribute to Zend Framework, please be sure to
5+
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/zf2/wiki/Coding-Standards)
9-
- [Contributor's Guide](CONTRIBUTING.md)
10-
- ZF Contributor's mailing list:
11-
Archives: http://zend-framework-community.634137.n4.nabble.com/ZF-Contributor-f680267.html
12-
Subscribe: zf-contributors-subscribe@lists.zend.com
13-
- ZF Contributor's IRC channel:
14-
#zftalk.dev on Freenode.net
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)
1512

16-
If you are working on new features or refactoring [create a proposal](https://github.com/zendframework/zend-expressive-zendviewrenderer/issues/new).
17-
18-
## Reporting Potential Security Issues
19-
20-
If you have encountered a potential security vulnerability, please **DO NOT** report it on the public
21-
issue tracker: send it to us at [zf-security@zend.com](mailto:zf-security@zend.com) instead.
22-
We will work with you to verify the vulnerability and patch it as soon as possible.
23-
24-
When reporting issues, please provide the following information:
25-
26-
- Component(s) affected
27-
- A description indicating how to reproduce the issue
28-
- A summary of the security vulnerability and impact
29-
30-
We request that you contact us via the email address above and give the project
31-
contributors a chance to resolve the vulnerability and issue a new release prior
32-
to any public exposure; this helps protect users and provides them with a chance
33-
to upgrade and/or update in order to protect their applications.
34-
35-
For sensitive email communications, please use [our PGP key](http://framework.zend.com/zf-security-pgp-key.asc).
13+
If you are working on new features or refactoring
14+
[create a proposal](https://github.com/zendframework/zend-expressive-zendviewrenderer/issues/new).
3615

3716
## RUNNING TESTS
3817

@@ -86,18 +65,6 @@ $ composer cs-fix
8665
If the above fixes any CS issues, please re-run the tests to ensure
8766
they pass, and make sure you add and commit the changes after verification.
8867

89-
## Running License Checks
90-
91-
File-level docblocks should follow the format demonstrated in `.docheader`. To
92-
check for conformity, use:
93-
94-
```console
95-
$ composer license-check
96-
```
97-
98-
This will flag files that are incorrect, which you can then update. Re-run the
99-
tool to verify your changes.
100-
10168
## Recommended Workflow for Contributions
10269

10370
Your first step is to establish a public repository from which we can
@@ -189,15 +156,7 @@ To send a pull request, you have two options.
189156
If using GitHub, you can do the pull request from there. Navigate to
190157
your repository, select the branch you just created, and then select the
191158
"Pull Request" button in the upper right. Select the user/organization
192-
"zendframework" as the recipient.
193-
194-
If using your own repository - or even if using GitHub - you can use `git
195-
format-patch` to create a patchset for us to apply; in fact, this is
196-
**recommended** for security-related patches. If you use `format-patch`, please
197-
send the patches as attachments to:
198-
199-
- zf-devteam@zend.com for patches without security implications
200-
- zf-security@zend.com for security patches
159+
"zendframework" (or whatever the upstream organization is) as the recipient.
201160

202161
#### What branch to issue the pull request against?
203162

@@ -228,8 +187,3 @@ repository, we suggest doing some cleanup of these branches.
228187
```console
229188
$ git push {username} :<branchname>
230189
```
231-
232-
233-
## Conduct
234-
235-
Please see our [CONDUCT.md](CONDUCT.md) to understand expected behavior when interacting with others in the project.

docs/ISSUE_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Provide a narrative description of the issue.
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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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+
- [ ] Base your feature on the `master` branch, and submit against that branch.
8+
- [ ] Add a regression test that demonstrates the bug, and proves the fix.
9+
- [ ] Add a `CHANGELOG.md` entry for the fix.
10+
11+
- [ ] Are you creating a new feature?
12+
- [ ] Why is the new feature needed? What purpose does it serve?
13+
- [ ] How will users use the new feature?
14+
- [ ] Base your feature on the `develop` branch, and submit against that branch.
15+
- [ ] Add only one feature per pull request; split multiple features over multiple pull requests
16+
- [ ] Add tests for the new feature.
17+
- [ ] Add documentation for the new feature.
18+
- [ ] Add a `CHANGELOG.md` entry for the new feature.
19+
20+
- [ ] Is this related to quality assurance?
21+
- [ ] Detail why the changes are necessary.
22+
23+
- [ ] Is this related to documentation?
24+
- [ ] Is it a typographical and/or grammatical fix?
25+
- [ ] Is it new documentation?

docs/SUPPORT.md

Lines changed: 25 additions & 0 deletions
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/questions/expressive)
9+
- To report issues, use this repository's
10+
[issue tracker](https://github.com/zendframework/zend-expressive-zendviewrenderer/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.

0 commit comments

Comments
 (0)