Skip to content

Contribute.md

Latest commit

 

History

History
103 lines (55 loc) · 3.44 KB

Contribute.md

File metadata and controls

103 lines (55 loc) · 3.44 KB

Contribution

Thank you very much for your interest in this project! There are plenty of ways you can support us. :-)

Code of Conduct

We like you to read and follow our code of conduct before contributing. Thank you.

Use it

The best and (probably) easiest way is to use the API client library for your own projects. It would be very nice to share your thoughts with us. We love to hear from you.

If you have questions how to use it properly read the documentation carefully.

Report bugs

If you find something strange please report it to our issue tracker.

Make a wish

Of course, there are some features in the pipeline. However, if you have good ideas how to improve the API client library please let us know! Write a feature request in our issue tracker.

Setup a development environment

If you like to contribute source code, documentation snippets, self-explaining examples or other useful bits, fork this repository, setup the environment and make a pull request.

git clone https://github.com/bheisig/i-doit-api-client-php.git

If you have a GitHub account create a fork first and then clone the repository.

After that, setup the environment with Composer:

composer install

Now it is the time to do your stuff. Do not forget to commit your changes. When you are done consider to make a pull requests.

Notice, that any of your contributions merged into this repository will be licensed under the AGPLv3.

Requirements

This projects has some dependencies:

  • PHP, version 5.6+
  • Composer
  • One or more working copies of i-doit (otherwise this API client library is senseless)

Developers must meet some more requirements:

Run unit tests

Unit tests are located under tests/. Just call make phpunit to execute all of them.

Release new version

… and publish it to packagist.org:

  • Bump version in composer.json

  • Update README.md and CHANGELOG.md

  • Commit changes

    git commit CHANGELOG.md composer.json README.md -m "Prepare release of version <VERSION>"

  • Create a tag with

    git tag -s -m "Release version <VERSION>" <VERSION>

    git push --tags

There is already a webhook enabled to push the code from GitHub to packagist. This needs commit rights for this repository.

Make rules

This project comes with some rules which will be used by make:

Make rule Description
gitstats Create a little website with Git statistics located under gitstats
gource Visualize git commits
phpdox Create a source code documentation
phploc Print source code statistics
phpunit Run unit tests

For example, execute make gource.

Donate

Last but not least, if you think this script is useful for your daily work, consider a donation. What about a beer?