File: CONTRIBUTING.md

Recommend this page to a friend!
  Classes of Omar Shaban  >  Resilient PHP Task Runner  >  CONTRIBUTING.md  >  Download  
File: CONTRIBUTING.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: Resilient PHP Task Runner
Run a task and retry while it fails for a period
Author: By
Last change:
Date: 1 month ago
Size: 1,999 bytes
 

Contents

Class file image Download

Contributing

We accept contributions via Pull Requests on Github.

Pull Requests

  • Code must follow PSR-1, PSR-2 Coding Standards - The easiest way to apply the conventions is to install PHP Code Sniffer and run it.
  • Add tests! - Your patch won't be accepted if it doesn't have tests. Run PHPUnit to make sure, that all tests pass.
  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.
  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option. Update CHANGES.md accordingly.
  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

Make shortcuts

If you have GNU Make installed, you can use following shortcuts:

  • run static code analysis with PHP_CodeSniffer
    to check code style
    
    
  • fix code style violations with PHP_CodeSniffer automatically, where possible (ex. PSR-2 code formatting violations)
  • run tests with PHPUnit
    
    
  • invokes described above install, cs, test tasks sequentially -
    project will be assembled, checked with linter and tested with one single command
    
    

Running Tests

$ make test

or

$ composer test

Happy coding!


For more information send a message to info at phpclasses dot org.