g1a/hubph

Template project for PHP libraries.

0.6.6 2022-03-21 21:28 UTC

Requires

• php: >=7.1.3
• consolidation/filter-via-dot-access-data: ^1 || ^2
• consolidation/robo: ^2.0.5 || ^3
• knplabs/github-api: ^2.14
• php-http/guzzle6-adapter: ^1.1
• symfony/console: ^2.8 || ^3 || ^4 || ^5
• symfony/filesystem: ^2.8 || ^3 || ^4.4

Requires (Dev)

• g1a/composer-test-scenarios: ^2
• phpunit/phpunit: ^5
• satooshi/php-coveralls: ^2
• squizlabs/php_codesniffer: ^3.6.1

MIT

• Greg Anderson

README

Hubph (pronounced "huff") is an experimental PHP implementation of Hub.

Getting Started

To try out hubph, download the phar from the releases section of the GitHub project.

This is just a prototype project, so documentation is sparse, and the commands and their options may change at any time.

This project does not necessarily do everything that Hub does, but it might also do some extra things that Hub does not do. The definition and scope of this project is still being explored.

Local Development

Clone this project and then run:

composer install

If you wish to build the phar for this project, install the box phar builder via:

composer phar:install-tools

Running the tests

The test suite may be run locally by way of some simple composer scripts:

Test	Command
Run all tests	composer test
PHPUnit tests	composer unit
PHP linter	composer lint
Code style	composer cs
Fix style errors	composer cbf

Deployment

• Edit the VERSION file to contain the version to release, and commit the change.
• Run composer release

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the releases page.

License

This project is licensed under the MIT License - see the LICENSE file for details