https://github.com/jeroendesloovere/package-skeleton

Skeleton for a PHP Package.
https://github.com/jeroendesloovere/package-skeleton

Last synced: 6 days ago
JSON representation

Skeleton for a PHP Package.

• Host: GitHub
• URL: https://github.com/jeroendesloovere/package-skeleton
• Owner: jeroendesloovere
• License: mit
• Created: 2014-06-04T11:50:17.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-12-18T09:38:28.000Z (about 10 years ago)
• Last Synced: 2024-11-11T06:49:23.885Z (about 2 months ago)
• Language: PHP
• Homepage:
• Size: 145 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# :package_title

[![Latest Stable Version](http://img.shields.io/packagist/v/jeroendesloovere/:package_name.svg)](https://packagist.org/packages/jeroendesloovere/:package_name)

[![License](http://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/jeroendesloovere/:package_name/blob/master/LICENSE)

[![Build Status](http://img.shields.io/travis/jeroendesloovere/:package_name.svg)](https://travis-ci.org/jeroendesloovere/:package_name)

> :package_api_description

:package_description

## Usage

### Installation

``` json

{

    "require": {

        "jeroendesloovere/:package_name": "1.0.*"

    }

}

```

> Adding this code in your `composer.json` file will get the [latest :package_name Packagist package](https://packagist.org/packages/jeroendesloovere/:package_name) using [Composer](https://getcomposer.org).

### Example

``` php

use JeroenDesloovere\Skeleton;

$skeleton = new Skeleton();

echo $skeleton->echoPhrase('Hello, World!');

```

> [View all examples](/examples/example.php) or check [the Wunderlist class](/src/).

### Tests

``` bash

$ phpunit

```

## Documentation

The class is well documented inline. If you use a decent IDE you'll see that each method is documented with PHPDoc.

## Contributing

Contributions are **welcome** and will be fully **credited**.

### Pull Requests

> To add or update code

- **Coding Syntax** - Please keep the code syntax consistent with the rest of the package.

- **Add unit tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behavior** - Make sure the README and any other relevant documentation are kept up-to-date.

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

- **Create topic branches** - Don't ask us to pull from your master branch.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **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.

### Issues

> For bug reporting or code discussions.

More info on how to work with GitHub on help.github.com.

## Credits

- [:author_name](https://github.com/:author_username)

- [All Contributors](https://github.com/jeroendesloovere/:package_name/contributors)

## License

The module is licensed under [MIT](./LICENSE.md). In short, this license allows you to do everything as long as the copyright statement stays present.