Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.8 KB
Raw

Contributions welcome!

Here's a quick guide:

  1. Fork the repo on GitHub.

  2. Update submodules: git submodule update --init

  3. Run the test suite. We only take pull requests with passing tests, and it's great to know that you have a clean slate. Make sure you have PHPUnit 3.5+, then run phpunit from the project directory.

  4. Add tests for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, add a test!

  5. Make the tests pass.

  6. Push your fork to GitHub and submit a pull request against the dev branch.

You can do some things to increase the chance that your pull request is accepted the first time:

  • Submit one pull request per fix or feature.
  • To help with that, do all your work in a feature branch (e.g. feature/my-alsome-feature).
  • Follow the conventions you see used in the project.
  • Use phpcs --standard=PSR2 to check your changes against the coding standard.
  • Write tests that fail without your code, and pass with it.
  • Don't bump version numbers. Those will be updated — per semver — once your change is merged into master.
  • Update any documentation: docblocks, README, examples, etc.
  • ... Don't update the wiki until your change is merged and released, but make a note in your pull request so we don't forget.

Mustache.php follows the PSR-* coding standards: