Skip to content

Commit

Permalink
Modernizes repository
Browse files Browse the repository at this point in the history
- Renames LICENSE.txt to LICENSE.md, and sets appropriate copyright range.
- Adds issue and PR templates.
- Adds code of conduct, contributing, and support guides.
- Updates composer.json structure to match other components.
  • Loading branch information
weierophinney committed Apr 17, 2018
1 parent fcb4d5a commit 70db3d5
Show file tree
Hide file tree
Showing 13 changed files with 364 additions and 54 deletions.
2 changes: 2 additions & 0 deletions .coveralls.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
coverage_clover: clover.xml
json_path: coveralls-upload.json
18 changes: 9 additions & 9 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/doc export-ignore
/test export-ignore
/vendor export-ignore
.coveralls.yml export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.travis.yml export-ignore
phpcs.xml export-ignore
phpunit.xml.dist export-ignore
/.coveralls.yml export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/composer.lock export-ignore
/docs/ export-ignore
/phpcs.xml export-ignore
/phpunit.xml.dist export-ignore
/test/ export-ignore
11 changes: 4 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
nbproject
.idea
.buildpath
.project
.settings/
.DS_Store
vendor/
/clover.xml
/coveralls-upload.json
/phpunit.xml
/vendor/
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ install:

script:
- composer test
- if [[ $CS_CHECK == 'true' ]]; then composer cs ; fi
- if [[ $CS_CHECK == 'true' ]]; then composer cs-check ; fi
18 changes: 9 additions & 9 deletions LICENSE.txt → LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
Copyright (c) 2005-2015, Zend Technologies USA, Inc.
Copyright (c) 2011-2018, Zend Technologies USA, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

* Neither the name of Zend Technologies USA, Inc. nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
- Neither the name of Zend Technologies USA, Inc. nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Zend Developer Tools

[![Build Status](https://travis-ci.org/zendframework/ZendDeveloperTools.svg)](https://travis-ci.org/zendframework/ZendDeveloperTools)
[![Build Status](https://secure.travis-ci.org/zendframework/ZendDeveloperTools.svg?branch=master)](https://secure.travis-ci.org/zendframework/ZendDeveloperTools)
[![Coverage Status](https://coveralls.io/repos/github/zendframework/ZendDeveloperTools/badge.svg?branch=master)](https://coveralls.io/github/zendframework/ZendDeveloperTools?branch=master)

Module providing debug tools for use with [zend-mvc](https://docs.zendframework.com/zend-mvc) applications.

Expand All @@ -17,6 +18,7 @@ Module providing debug tools for use with [zend-mvc](https://docs.zendframework.
2. Add the `ZendDeveloperTools` module to the module section of your `config/application.config.php`.
Starting with version 1.1.0, if you are using [zend-component-installer](https://docs.zendframework.com/zend-component-installer),
this will be done for you automatically.

3. Copy `./vendor/zendframework/zend-developer-tools/config/zenddevelopertools.local.php.dist` to
`./config/autoload/zenddevelopertools.local.php`. Change any settings in it
according to your needs.
Expand Down
60 changes: 34 additions & 26 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,34 +1,20 @@
{
"name": "zendframework/zend-developer-tools",
"description": "Module for developer and debug tools for use with zend-mvc applications.",
"type": "library",
"license": "BSD-3-Clause",
"keywords": [
"zendframework",
"debug",
"developer",
"zf2",
"zf",
"module"
],
"homepage": "https://github.com/zendframework/ZendDeveloperTools",
"authors": [
{
"name": "Evan Coury",
"email": "[email protected]",
"homepage": "http://blog.evan.pro/"
},
{
"name": "Eric Boh",
"email": "[email protected]"
}
],
"extra": {
"branch-alias": {
"dev-master": "1.1-dev",
"dev-develop": "1.2-dev"
},
"zf": {
"module": "ZendDeveloperTools"
}
"support": {
"issues": "https://github.com/zendframework/ZendDeveloperTools/issues",
"source": "https://github.com/zendframework/ZendDeveloperTools",
"rss": "https://github.com/zendframework/ZendDeveloperTools/releases.atom",
"chat": "https://zendframework-slack.herokuapp.com",
"forum": "https://discourse.zendframework.com/c/questions/components"
},
"require": {
"php": "^5.6 || ^7.0",
Expand Down Expand Up @@ -63,15 +49,37 @@
"ZendDeveloperToolsTest\\": "test/"
}
},
"config": {
"sort-packages": true
},
"extra": {
"branch-alias": {
"dev-master": "1.1.x-dev",
"dev-develop": "1.2.x-dev"
},
"zf": {
"module": "ZendDeveloperTools"
}
},
"scripts": {
"check": [
"@cs-check",
"@test"
],
"coveralls": "coveralls",
"cs-check": "phpcs",
"cs-fix": "phpcbf",
"test": "phpunit",
"test-coverage": "phpunit --coverage-clover clover.xml"
}
"test": "phpunit --colors=always",
"test-coverage": "phpunit --colors=always --coverage-clover clover.xml"
},
"authors": [
{
"name": "Evan Coury",
"email": "[email protected]",
"homepage": "http://blog.evan.pro/"
},
{
"name": "Eric Boh",
"email": "[email protected]"
}
]
}
2 changes: 1 addition & 1 deletion composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

43 changes: 43 additions & 0 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributor Code of Conduct

This project adheres to [The Code Manifesto](http://codemanifesto.com)
as its guidelines for contributor interactions.

## The Code Manifesto

We want to work in an ecosystem that empowers developers to reach their
potential — one that encourages growth and effective collaboration. A space that
is safe for all.

A space such as this benefits everyone that participates in it. It encourages
new developers to enter our field. It is through discussion and collaboration
that we grow, and through growth that we improve.

In the effort to create such a place, we hold to these values:

1. **Discrimination limits us.** This includes discrimination on the basis of
race, gender, sexual orientation, gender identity, age, nationality, technology
and any other arbitrary exclusion of a group of people.
2. **Boundaries honor us.** Your comfort levels are not everyone’s comfort
levels. Remember that, and if brought to your attention, heed it.
3. **We are our biggest assets.** None of us were born masters of our trade.
Each of us has been helped along the way. Return that favor, when and where
you can.
4. **We are resources for the future.** As an extension of #3, share what you
know. Make yourself a resource to help those that come after you.
5. **Respect defines us.** Treat others as you wish to be treated. Make your
discussions, criticisms and debates from a position of respectfulness. Ask
yourself, is it true? Is it necessary? Is it constructive? Anything less is
unacceptable.
6. **Reactions require grace.** Angry responses are valid, but abusive language
and vindictive actions are toxic. When something happens that offends you,
handle it assertively, but be respectful. Escalate reasonably, and try to
allow the offender an opportunity to explain themselves, and possibly correct
the issue.
7. **Opinions are just that: opinions.** Each and every one of us, due to our
background and upbringing, have varying opinions. The fact of the matter, is
that is perfectly acceptable. Remember this: if you respect your own
opinions, you should respect the opinions of others.
8. **To err is human.** You might not intend it, but mistakes do happen and
contribute to build experience. Tolerate honest mistakes, and don't hesitate
to apologize if you make one yourself.
Loading

0 comments on commit 70db3d5

Please sign in to comment.