feat: Ensure PR title fits convention (#3683)

.github/pull_request_template.md

@@ -1,6 +1,12 @@
 <!--
   This template provides some ideas of things to include in your PR description.
-  To start, try providing a short summary of your changes in the Title above.
+  
+  To start, try providing a short summary of your changes in the Title above. We follow Conventional Commits syntax, please ensure your title is prefixed with one of:
+  - `feat: `
+  - `fix: `
+  - `docs: `
+  - `chore: `
+  
   If a section of the PR template does not apply to this PR, then delete that section.
 
   PLEASE READ:
@@ -36,6 +42,8 @@ _(REQUIRED)_
   Briefly explain any decisions you made with respect to the changes.
   Include anything here that you didn't include in *Release Notes*
   above, such as changes to CI or changes to internal methods.
+
+  If there is a UI component to the change, please include before/after images.
 -->
 
 ## Which issue(s) this PR fixes:
@@ -44,7 +52,7 @@ _(REQUIRED)_
 
 <!--
 If this PR fixes one of more issues, list them here.
-One line each, like so:
+One per line, like so:
 Fixes #123
 Fixes #39
 -->

.github/workflows/pull-request-lint.yml

@@ -0,0 +1,41 @@
+name: Pull Request Linter
+
+on:
+  workflow_call:
+  pull_request:
+    types: [edited] # This captures the PR title changing
+    branches:
+      - mealie-next
+
+jobs:
+  validate-title:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      # https://github.com/amannn/action-semantic-pull-request
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Configure which types are allowed (newline-delimited).
+          # Default: https://github.com/commitizen/conventional-commit-types
+          types: |
+            fix
+            feat
+            docs
+            chore
+          # Configure which scopes are allowed (newline-delimited).
+          # These are regex patterns auto-wrapped in `^ $`.
+          scopes: |
+            deps
+            auto
+            l10n
+          # Configure that a scope must always be provided.
+          requireScope: false
+          # If the PR contains one of these newline-delimited labels, the
+          # validation is skipped. If you want to rerun the validation when
+          # labels change, you might want to use the `labeled` and `unlabeled`
+          # event triggers in your workflow.
+          ignoreLabels: |
+            bot
+            ignore-semantic-pull-request

.github/workflows/pull-requests.yml

@@ -6,6 +6,10 @@ on:
       - mealie-next
 
 jobs:
+  pull-request-lint:
+    name: "Lint PR"
+    uses: ./.github/workflows/pull-request-lint.yml
+
   backend-tests:
     name: "Backend Server Tests"
     uses: ./.github/workflows/partial-backend.yml

crowdin.yml

@@ -1,4 +1,8 @@
 preserve_hierarchy: false
+pull_request_title: "chore(l10n): New Crowdin updates"
+pull_request_labels: [
+  "l10n"
+]
 files:
   - source: /frontend/lang/messages/en-US.json
     translation: /frontend/lang/messages/%locale%.json

docs/docs/contributors/developers-guide/code-contributions.md

@@ -2,11 +2,11 @@
 
 [Please Join the Discord](https://discord.gg/QuStdQGSGK). We are building a community of developers working on the project.
 
-## We Develop with Github
-We use github to host code, to track issues and feature requests, as well as accept pull requests.
+## We Develop with GitHub
+We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
 
-## We Use [Github Flow](https://docs.github.com/en/get-started/using-github/github-flow), So All Code Changes Happen Through Pull Requests
-Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/using-github/github-flow)). We actively welcome your pull requests:
+## We Use [GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow)). We actively welcome your pull requests:
 
 1. Fork the repo and create your branch from `mealie-next`.
 2. Checkout the Discord, the PRs page, or the Projects page to get an idea of what's already being worked on.
@@ -14,13 +14,13 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 4. Once you've got an idea of what changes you want to make, create a draft PR as soon as you can to let us know what you're working on and how we can help!
 5. If you've changed APIs, update the documentation.
 6. Run tests, including `task py:check`.
-6. Issue that pull request! First make a draft PR, make sure that the automated github tests all pass, then mark as ready for review.
-7. Be sure to add release notes to the pull request.
+7. Issue that pull request! First make a draft PR, make sure that the automated GitHub tests all pass, then mark as ready for review. We follow Conventional Commits syntax; please title your PR as described in the PR template.
+8. Be sure to add release notes to the pull request.
 
 ## Any contributions you make will be under the AGPL Software License
 In short, when you submit code changes, your submissions are understood to be under the same [AGPL License](https://choosealicense.com/licenses/agpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern.
 
-## Report bugs using Github's [issues](https://github.com/mealie-recipes/mealie/issues)
+## Report bugs using GitHub's [issues](https://github.com/mealie-recipes/mealie/issues)
 We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/mealie-recipes/mealie/issues/new); it's that easy!
 
 ## Write bug reports with detail, background, and sample code