Skip to content
This repository has been archived by the owner on Mar 27, 2019. It is now read-only.

Latest commit

 

History

History
44 lines (31 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.65 KB

Contributing

Asplode is open source software; contributions from the community are encouraged. Please take a moment to read these guidelines before submitting changes.

Code style

All PHP code must adhere to the PSR-2 standards.

Branching and pull requests

As a guideline, please follow this process:

  1. Fork the repository.
  2. Create a topic branch for the change, branching from develop (git checkout -b branch-name develop).
  3. Make the relevant changes.
  4. Squash commits if necessary (git rebase -i develop).
  5. Submit a pull request to the develop branch.

Tests and API documentation

This project uses Archer for testing, and API documentation generation:

  • Run the tests with vendor/bin/archer t path/to/tests, or simply vendor/bin/archer to run the entire suite.
  • Generate a coverage report with vendor/bin/archer c path/to/tests, or simply vendor/bin/archer c to generate coverage for the entire suite. Add -o to open the report in your browser.
  • Generate API documentation with vendor/bin/archer d. Serve with php -S localhost:8000 -t artifacts/documentation/api/, and open your browser to http://localhost:8000/.

For more detailed usage, see the Archer documentation.