Skip to content

Commit

Permalink
Updated files with default license, updated contribution guide, chang…
Browse files Browse the repository at this point in the history
…elog, travis config
  • Loading branch information
hollodotme committed Nov 20, 2016
1 parent 98559f3 commit 2685a12
Show file tree
Hide file tree
Showing 9 changed files with 65 additions and 72 deletions.
27 changes: 0 additions & 27 deletions build/phpmd.xml

This file was deleted.

5 changes: 2 additions & 3 deletions src/CodeTemplates/Component/.gitignore
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
.idea
.idea/

# vagrant
.vagrant/
vagrant

# composer
vendor/
composer.lock

# locally generated docs
build/api/
build/phpdox/
build/logs/
build/logs/
8 changes: 4 additions & 4 deletions src/CodeTemplates/Component/.travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ branches:
- master
- development
- /^feature\/.+$/
- /^issue\/.+$/

before_script:
- git checkout $TRAVIS_BRANCH
- composer self-update
- mkdir -p vendor/bin
- composer install -o --prefer-dist --no-interaction
- mkdir build/logs

script:
- php vendor/bin/phpunit -c build/
- php vendor/bin/phpunit.phar -c build/

after_success:
- travis_retry php vendor/bin/coveralls -v --exclude-no-stmt
- travis_retry php vendor/bin/coveralls.phar -v --exclude-no-stmt

notifications:
slack: fortunesolutions:PoLjMJuARdFicBIEPzdNrZ96
slack: fortune-globe:PoLjMJuARdFicBIEPzdNrZ96
5 changes: 5 additions & 0 deletions src/CodeTemplates/Component/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Change Log

All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a CHANGELOG](http://keepachangelog.com).

## [Unreleased]


[Unreleased](https://github.com/__COMPOSER_NAME__/blob/master)
25 changes: 22 additions & 3 deletions src/CodeTemplates/Component/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ Contributions are **welcome** and will be fully **credited**.

We accept contributions via pull requests on [GitHub](https://github.com/__COMPOSER_NAME__).

## Issues

- Please report issues here on [GitHub](https://github.com/__COMPOSER_NAME__)

## Pull Requests

- **Add tests!** - Your patch will not be accepted if it does not have tests.

- **Document any change in behaviour** - Make sure the documentation in `README.md` is kept up-to-date.
- **Document any change in behaviour** - Make sure the documentation in `README.md` and the `CHANGELOG.md` is kept up-to-date.

- **Consider our release cycle** - We follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

Expand All @@ -20,6 +23,22 @@ We accept contributions via pull requests on [GitHub](https://github.com/__COMPO
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.


## Running Tests
## Running tests

```bash
$ php vendor/bin/phpunit.phar -c build/
```

This includes a code coverage report in HTML and Clover XML.

## Analyze code

```bash
$ php vendor/bin/phpmetrics.phar --report-html=build/logs/phpmetrics src/
```

## Create API documentation

$ vendor/bin/phpunit -c build/
```bash
$ php vendor/bin/phpdox.phar -f build/phpdox.xml
```
27 changes: 0 additions & 27 deletions src/CodeTemplates/Component/build/phpmd.xml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
<?php
<?php declare(strict_types = 1);
/**
* @author __AUTHOR__
* Copyright (c) 2016 Holger Woltersdorf & Contributors
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*/

namespace __NAMESPACE__\Exceptions;
Expand All @@ -12,4 +20,4 @@
class __COMPONENT_NAME__Exception extends \Exception
{

}
}
14 changes: 11 additions & 3 deletions src/CodeTemplates/Component/src/__COMPONENT_NAME__.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
<?php
<?php declare(strict_types = 1);
/**
* @author __AUTHOR__
* Copyright (c) 2016 Holger Woltersdorf & Contributors
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*/

namespace __NAMESPACE__;
Expand All @@ -12,4 +20,4 @@
class __COMPONENT_NAME__
{

}
}
12 changes: 10 additions & 2 deletions src/CodeTemplates/Component/tests/Unit/__COMPONENT_NAME__Test.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
<?php
<?php declare(strict_types = 1);
/**
* @author __AUTHOR__
* Copyright (c) 2016 Holger Woltersdorf & Contributors
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*/

namespace __NAMESPACE__\Tests\Unit;
Expand Down

0 comments on commit 2685a12

Please sign in to comment.