Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

76 lines (57 loc) · 2.13 KB

Contributing

When submitting pull requests please follow the following guidelines:

QA

There are a few QA tests which every commit has to pass. Please install the following Git hooks:

# from project root
cp config/pre-commit .git/hooks/
cp config/pre-push .git/hooks/

These hooks enforce coding style, code coverage, use of @covers annotation and checks for debug statements. On pre-commit only coding style is enforced, on pre-push everything has to pass.

Git Commit Messages

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

Reference: How to Write a Git Commit Message by Chris Beams

Coding Style

PSR-2

Type Safety

  • PHP is a dynamic language and that is great for many things
  • BUT with great power comes great responsibility
  • so please use type hints where ever possible
  • functional methods (each, reduce, map, ...) are preferable to loops

How to Release

Bump versions in

  • CHANGELOG.md
  • README.md
  • bin/dephpend
  • test files

Then run:

# change these
VERSION="MAJOR.MINOR.PATCH"
COMMIT_EMAIL="[email protected]"

# copy & paste
[[ -z $(git status --porcelain) ]] && \  
  make phar && \
  mv "build/dephpend.phar" "build/dephpend-$VERSION.phar" && \
  gpg --local-user "${COMMIT_EMAIL}" --detach-sign --output "build/dephpend-${VERSION}.phar.asc" "build/dephpend-${VERSION}.phar" && \
  gpg --verify "build/dephpend-${VERSION}.phar.asc" "build/dephpend-${VERSION}.phar" && \
  bin/prepare-tag "${VERSION}" && \
  git push && \
  git push origin "${VERSION}"

Then upload to GitHub releases and verify via phive install dephpend or phive update dephpend.

The update the documentation

git checkout gh-pages && \
  git merge --no-edit origin/main && \
  make pages && \
  git commit index.html -m "Update documentation" && \
  git push && \
  git checkout main