CONTRIBUTING.md 803 B

Contributing

Contributions are most welcome, and the more eyes on the code the better.

To get started:

  • Fork this library
  • Check out the code:
    • git clone git@github.com:yourfork/bech32 && cd bech32
  • Start your own branch:
    • git checkout -b your-feature-branch
  • Check your work:
    • Codestyle check: vendor/bin/phpcs -n --standard=PSR1,PSR2 src test
    • Codestyle fixer: vendor/bin/phpcbf --standard=PSR1,PSR2 src test
    • Run tests: vendor/bin/phpunit
    • Run tests with coverage: vendor/bin/phpunit --coverage-html=build
  • Check code coverage: build
  • Commit your work: git commit ...
  • Push your work:
    • git push origin your-feature-branch
  • And open a pull request!

Please GPG sign your commits if possible: git commit -S ...