Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 1.75 KB
Raw

Contributing Guidelines

Contributions to FlorianWolters\CodeKata are always welcome.

Please use the following two GitHub features to contribute:

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

Getting Started

  1. Sign up for GitHub.
  2. Fork the repository on GitHub.
  3. Clone the repository into a new directory on your 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.
  8. Submit a pull request.

Clone the repository into a new directory on your local host.

Run the following commands to initially checkout FlorianWolters\CodeKata:

md Singleton && cd Singleton
git clone git://github.com/FlorianWolters/PHP-Component-Util-Singleton.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 is required.

PHPUnit can be installed via the PEAR installer. Run the following commands to install PHPUnit:

pear preferred_state stable
pear config-set auto_discover 1
pear channel-discover pear.phpunit.de
pear install --alldeps phpunit/PHPUnit

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

phpunit