diff --git a/.github/workflows/lint-and-analyse-php.yml b/.github/workflows/lint-and-analyse-php.yml index defd7f7e0..87083ec8e 100644 --- a/.github/workflows/lint-and-analyse-php.yml +++ b/.github/workflows/lint-and-analyse-php.yml @@ -17,6 +17,19 @@ permissions: contents: read jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4.2.2 + with: + fetch-depth: 0 + - uses: actions/setup-python@v5.4.0 + with: + python-version: "3.13" + - run: pip install --upgrade tox + - name: Run commitizen (https://commitizen-tools.github.io/commitizen/) + run: tox -e cz + markdownlint: runs-on: ubuntu-latest steps: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9c048c5b..b1516b152 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,3 +86,120 @@ We'd love to hear your ideas for improving LibreBooking. 4. Your PR will be reviewed by maintainers. We aim to review PRs in a timely manner, but please be patient. 5. Address any feedback or requested changes. 6. Once your PR is approved and CI checks pass, it will be merged. Thank you for your contribution. + +## Commit Message Guidelines + +We have precise rules over how our git commit messages should be formatted. +This leads to more readable messages that are easy to follow when looking +through the project history. This also enables us to automate our Changelog +generation at release time. + +### Commit Message Format + +Each commit message consists of a **header**, a **body** and a **footer**. The +header has a special format that includes a **type**, a **scope** and a +**subject**: + +```text +(): + + + +