-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Enhanced source code documentation. * Improved Composer integration. Signed-off-by: Florian Wolters <wolters.fl@gmail.com>
- Loading branch information
1 parent
f945e15
commit 7056caf
Showing
12 changed files
with
2,408 additions
and
263 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,80 @@ | ||
# Contributing Guidelines | ||
|
||
Contributions to **FlorianWolters\Component\Core\DebugPrint** are always welcome. | ||
## Table of Contents (ToC) | ||
|
||
Once version *1.0.0* is reached, I will try to keep backwards compatibility breaks to an **absolute minimum**. Please keep that in account when you propose a change or a feature. | ||
* [Introduction](#introduction) | ||
* [Process](#process) | ||
* [Licensing](#licensing) | ||
|
||
## Introduction | ||
|
||
Contributions to [**FlorianWolters\Component\Core\DebugPrint**][10] are | ||
**welcome** and will be **credited**. | ||
|
||
**Note:** Once version *1.0.0* is reached, all contributors shall try to keep | ||
backwards compatibility breaks to an **absolute minimum**. | ||
|
||
Please be aware of the above note when proposing a change or a feature. | ||
|
||
Please use the following two [GitHub][1] features to contribute: | ||
|
||
1. Report an *issue*. | ||
2. Submit a *pull request*. | ||
1. Report an [*issue*][11]. | ||
2. Submit a [*pull request*][12]. | ||
|
||
## Getting Started | ||
## Process | ||
|
||
1. [Sign up][2] for GitHub. | ||
2. *Fork* the repository on GitHub. | ||
3. *Clone* the repository into a new directory on your local host. | ||
2. [*Fork*][13] the project repository on GitHub. | ||
3. *Clone* the project repository into a new directory on a local host. | ||
4. Modify the implementation source code. | ||
5. Modify the test source code. Refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug **do add** a **new** test. | ||
6. Run the test suite(s). I only accept pull requests with **passing tests**. | ||
7. *Commit* and *Push* to the *fork*. | ||
5. Modify the test source code. Refactoring and documentation changes require no | ||
new tests. If adding functionality or fixing a bug **do add** a **new** test. | ||
6. Run the test suite(s). Only pull requests with **passing tests** are | ||
accepted. | ||
7. *Commit* and *Push* to the previously created *fork*. | ||
8. Submit a *pull request*. | ||
|
||
### Clone the repository into a new directory on your local host. | ||
### Clone the repository into a new directory on a local host. | ||
|
||
Run the following commands to initially checkout **FlorianWolters\Component\Core\DebugPrint**: | ||
Run the following commands to checkout | ||
[**FlorianWolters\Component\Core\DebugPrint**][10]: | ||
|
||
md DebugPrint && cd DebugPrint | ||
git clone git://github.com/FlorianWolters/PHP-Component-Core-DebugPrint.git | ||
|
||
### Run the test suite(s) | ||
|
||
Before you send a pull request, run all test suite(s). To run the test suite(s), a system-wide installation of [PHPUnit][3] is required. | ||
Before sending a pull request, run all test suite(s). To run the test suite(s) | ||
[PHPUnit][3] is required, which is defined as a `require-dev` in the | ||
[`composer.json`][14] [Composer][4] configuration file of the project. | ||
|
||
[PHPUnit][3] can be installed via the [PEAR installer][4]. Run the following commands to install [PHPUnit][3]: | ||
Run the test suite(s) with the following command in the directory with the local | ||
Git repository: | ||
|
||
pear preferred_state stable | ||
pear config-set auto_discover 1 | ||
pear channel-discover pear.phpunit.de | ||
pear install --alldeps phpunit/PHPUnit | ||
phpunit | ||
|
||
Run the test suite(s) with the following command in the directory with the local Git repository: | ||
## Licensing | ||
|
||
phpunit | ||
By contributing source code the contributor agrees to license the contributions | ||
under the GNU [Lesser General Public License (LGPL)][5]. | ||
|
||
[1]: https://github.com | ||
"GitHub" | ||
[2]: https://github.com/signup/free | ||
"Sign up for GitHub" | ||
[3]: http://phpunit.de | ||
"sebastianbergmann/phpunit · GitHub" | ||
[4]: http://pear.php.net/manual/en/guide.users.commandline.cli.php | ||
"Manual :: Command line installer (PEAR)" | ||
[3]: https://phpunit.de | ||
"PHPUnit" | ||
[4]: https://getcomposer.com | ||
"Composer" | ||
[5]: https://gnu.org/licenses/lgpl.txt | ||
"GNU Lesser General Public License" | ||
[10]: https://github.com/FlorianWolters/PHP-Component-Core-DebugPrint | ||
"FlorianWolters/PHP-Component-Core-DebugPrint · GitHub" | ||
[11]: https://github.com/FlorianWolters/PHP-Component-Core-DebugPrint/issues | ||
"Issues · FlorianWolters/PHP-Component-Core-DebugPrint · GitHub" | ||
[12]: https://github.com/FlorianWolters/PHP-Component-Core-DebugPrint/pulls | ||
"Pull Requests · FlorianWolters/PHP-Component-Core-DebugPrint · GitHub" | ||
[13]: https://github.com/FlorianWolters/PHP-Component-Core-DebugPrint/fork | ||
"Fork your own copy of FlorianWolters/PHP-Component-Core-DebugPrint to your account" | ||
[14]: https://github.com/FlorianWolters/PHP-Component-Core-DebugPrint/blob/master/composer.json | ||
"PHP-Component-Core-DebugPrint/composer.json at master · FlorianWolters/PHP-Component-Core-DebugPrint" |
Oops, something went wrong.