Skip to content
This repository has been archived by the owner on Oct 16, 2019. It is now read-only.

Commit

Permalink
Added docheader tool.
Browse files Browse the repository at this point in the history
  • Loading branch information
demiankatz committed Mar 10, 2017
1 parent 4f1cdfa commit e49b26f
Show file tree
Hide file tree
Showing 4 changed files with 346 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .docheader
@@ -0,0 +1,5 @@
/**
* @see https://github.com/zendframework/ZendService_Amazon for the canonical source repository
* @copyright Copyright (c) %regexp:(20\d{2}-)?20\d{2}% Zend Technologies USA Inc. (http://www.zend.com)
* @license https://github.com/zendframework/ZendService_Amazon/blob/master/LICENSE.md New BSD License
*/
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -56,6 +56,18 @@ $ composer cs-fix
If you allow `phpcbf` to fix CS issues, please re-run the tests to ensure
they pass, and make sure you add and commit the changes after verification.

## Running License Checks

File-level docblocks should follow the format demonstrated in `.docheader`. To
check for conformity, use:

```console
$ composer license-check
```

This will flag files that are incorrect, which you can then update. Re-run the
tool to verify your changes.

## Recommended Workflow for Contributions

Your first step is to establish a public repository from which we can
Expand Down
5 changes: 3 additions & 2 deletions composer.json
Expand Up @@ -31,6 +31,7 @@
"zendframework/zendxml": "^1.0"
},
"require-dev": {
"malukenho/docheader": "^0.1.5",
"phpunit/phpunit": "^6.0.8 || ^5.7.15",
"zendframework/zend-coding-standard": "~1.0.0",
"zendframework/zend-i18n": "~2.0"
Expand All @@ -55,6 +56,6 @@
"cs-fix": "phpcbf",
"test": "phpunit --colors=always",
"test-coverage": "phpunit --coverage-clover clover.xml",
"license-check": "true"
}
"license-check": "vendor/bin/docheader check library/ tests/"
}
}
327 changes: 326 additions & 1 deletion composer.lock

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

0 comments on commit e49b26f

Please sign in to comment.