mirror of
https://github.com/pierre42100/comunic
synced 2024-11-27 07:49:28 +00:00
57 lines
2.7 KiB
Markdown
57 lines
2.7 KiB
Markdown
|
#  RocketTheme Toolbox
|
||
|
|
|
||
|
|
[](https://packagist.org/packages/rockettheme/toolbox)
|
||
|
|
[](LICENSE)
|
||
|
|
[](https://travis-ci.org/rockettheme/toolbox)
|
||
|
|
[](https://scrutinizer-ci.com/g/rockettheme/toolbox/code-structure)
|
||
|
|
[](https://scrutinizer-ci.com/g/rockettheme/toolbox)
|
||
|
|
[](https://packagist.org/packages/rockettheme/toolbox)
|
||
|
|
|
||
|
|
RocketTheme\Toolbox package contains a set of reusable PHP interfaces, classes and traits.
|
||
|
|
|
||
|
|
* ArrayTraits
|
||
|
|
* DI
|
||
|
|
* Event
|
||
|
|
* File
|
||
|
|
* ResourceLocator
|
||
|
|
* Session
|
||
|
|
* StreamWrapper
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
You can use [Composer](http://getcomposer.org/) to download and install this package as well as its dependencies.
|
||
|
|
|
||
|
|
### Composer
|
||
|
|
|
||
|
|
To add this package as a local, per-project dependency to your project, simply add a dependency on `rockettheme/toolbox` to your project's `composer.json` file. Here is a minimal example of a `composer.json` file that just defines a dependency on Diff:
|
||
|
|
|
||
|
|
{
|
||
|
|
"require": {
|
||
|
|
"rockettheme/toolbox": "dev-master"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
# Contributing
|
||
|
|
|
||
|
|
We appreciate any contribution to ToolBox, whether it is related to bugs or simply a suggestion or improvement.
|
||
|
|
However, we ask that any contribution follow our simple guidelines in order to be properly received.
|
||
|
|
|
||
|
|
All our projects follow the [GitFlow branching model][gitflow-model], from development to release. If you are not familiar with it, there are several guides and tutorials to make you understand what it is about.
|
||
|
|
|
||
|
|
You will probably want to get started by installing [this very good collection of git extensions][gitflow-extensions].
|
||
|
|
|
||
|
|
What you mainly want to know is that:
|
||
|
|
|
||
|
|
- All the main activity happens in the `develop` branch. Any pull request should be addressed only to that branch. We will not consider pull requests made to the `master`.
|
||
|
|
- It's very well appreciated, and highly suggested, to start a new feature whenever you want to make changes or add functionalities. It will make it much easier for us to just checkout your feature branch and test it, before merging it into `develop`
|
||
|
|
|
||
|
|
|
||
|
|
# Getting Started
|
||
|
|
|
||
|
|
* Have fun!!!
|
||
|
|
|
||
|
|
|
||
|
|
[gitflow-model]: http://nvie.com/posts/a-successful-git-branching-model/
|
||
|
|
[gitflow-extensions]: https://github.com/nvie/gitflow
|