Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

80 lines (60 loc) · 2.91 KB

Contributing Guidelines

Table of Contents (ToC)

Introduction

Contributions to FlorianWolters\Component\Util\Singleton 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 features to contribute:

  1. Report an issue.
  2. Submit a pull request.

Process

  1. Sign up for GitHub.
  2. Fork 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 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 a local host.

Run the following commands to checkout FlorianWolters\Component\Util\Singleton:

md Singleton && cd Singleton
git clone git://github.com/FlorianWolters/PHP-Component-Util-Singleton.git

Run the test suite(s)

Before sending a pull request, run all test suite(s). To run the test suite(s) PHPUnit is required, which is defined as a require-dev in the composer.json Composer configuration file of the project.

Run the test suite(s) with the following command in the directory with the local Git repository:

phpunit

Licensing

By contributing source code the contributor agrees to license the contributions under the GNU Lesser General Public License (LGPL).