Skip to content

Contributing to OpenCal

Thank you for your interest in contributing to OpenCal! 🎉
Your contributions help make this project better for everyone.

Code of Conduct

This project adheres to a Code of Conduct.
By participating, you are expected to uphold this code. Please report any unacceptable behavior to kontakt@var-lab.com.

Getting Started

To set up your local dev environment, please read the Readme in the local-dev repository.

How to Contribute

You can contribute in many ways:

  • Reporting bugs or vulnerabilities
  • Fixing issues (check the issue tracker)
  • Improving documentation
  • Adding new features
  • Improving tests and/or test coverage
  • Reviewing and commenting on open pull requests

Development Guidelines

  • Fork the repositories
  • Follow the coding style used throughout the project
  • Make sure all tests pass before submitting a pull request
  • Add or update tests when introducing changes
  • Update documentation if applicable
  • Keep your pull request focused and avoid unrelated changes

To run tests:

make backend.sh
# and then
composer run tests

To run phpstan:

make backend.sh
# and then
composer run phpstan

To run PHP linter:

make backend.sh
# and then
composer run lint:php
composer run lint:php:fix

Run hadolint

docker run --rm -i hadolint/hadolint < Dockerfile
# OR
docker run --rm -i ghcr.io/hadolint/hadolint < Dockerfile

Code commits

Please create merge requests to add your changes to the project.

Your commit message must include the type of change for the changelog. Use the following format:

git commit -m "<brief description>" -m "Changelog: <type>"

Valid types are:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation
  • chore: Maintenance

License

By contributing, you agree that your contributions will be licensed under the GNU AGPLv3 License.

Thank you for your contribution!