Maintainers

Getting Started

Using PHPCI

Contributing

Plugins

3rd Party and custom plugins

Maintainers help to keep the PHPCI project moving, they do this by helping to manage issues, merging pull requests, improving documentation and by contributing code to the project.

Want to be a maintainer? Email Dan at [email protected] for more information.

The current team of maintainers are as follows:

Core Maintainers

  • Dan (@dancryer)
  • Steve (@meadsteve)

Maintainers

  • Mike (@mikebronner)
  • James (@jfi)
  • Tobias (@tvbeek)
  • Marco (@mavimo)

Guidelines for Maintainers

Commit Access

Maintainers, by definition, have commit access to the project and can commit changes on behalf of contributors. However, with the exception of the core maintainers, maintainers are not entitled to bypass the contribution / pull request process.

Merging Pull Requests

It is the responsibility of the maintainers to merge pull requests, but only where they meet the contribution guidelines and pass our merging checklist.

Once the checklist has been completed, the pull request can be merged following the guidelines in the following blog post: http://blog.spreedly.com/2014/06/24/merge-pull-request-considered-harmful/

The Checklist

Is the pull-request ready to be merged?

The maintainer should check that the author has fully completed the bug fix / feature / refactor before merging the pull request.

Has the author properly explained the intended purpose of their pull request, and detailed their changes?

Authors need to explain in clear, concise language, what their patch is intended to do. Where their implementation is large or in any way complex, the changes themselves should be documented at the code level.

Has the author provided documentation updates for any new or changed features?

The wiki should not be updated until the pull request is merged, but documentation updates should be detailed in the pull request itself.

Has the pull request passed PHPCI checks?

It goes without saying that the project master branch should always pass its own PHPCI tests. This means that the patch will need to be PSR-2 compliant, all classes and methods should have valid docblocks, and all tests should pass.

Have at least two maintainers approved this pull request?

At least two maintainers should approve every pull request before it is merged. If you are the second maintainer to review a pull request, pending your approval it can be merged. Otherwise, apply the "flag:ready-to-merge" label to the pull request and consider tagging another maintainer to follow you.

You can edit this page on Github. Your changes will appear on this site within 15 minutes.

Subscribe to the PHPCI Newsletter