From 772baf7b0bd112bf1ecf1f8bfc50a5c39b327a7c Mon Sep 17 00:00:00 2001 From: admin Date: Thu, 18 Dec 2025 10:52:36 -0600 Subject: [PATCH] docs: update community standards with conventional commits and Aletheia branding --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 +++--- .github/ISSUE_TEMPLATE/config.yml | 6 ++--- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- CONTRIBUTING.md | 31 ++++++++++++++++++++-- 4 files changed, 37 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index de8f6a992a..92f8db7874 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: Bug Report -description: 'Report a new bug, if you are not 100% certain this is a bug please go to our Discord first' +description: 'Report a bug in Aletheia' labels: ['Type: Bug', 'Status: Needs Triage'] body: - type: checkboxes @@ -38,14 +38,14 @@ body: description: | examples: - **OS**: Ubuntu 20.04 - - **Radarr**: Radarr 3.0.1.4259 + - **Aletheia**: Aletheia 5.17.x - **Docker Install**: Yes - **Using Reverse Proxy**: No - **Browser**: Firefox 90 (If UI related) - **Database**: Sqlite 3.36.0 value: | - OS: - - Radarr: + - Aletheia: - Docker Install: - Using Reverse Proxy: - Browser: @@ -67,7 +67,7 @@ body: attributes: label: Trace Logs? **Not Optional** description: | - Trace Logs (https://wiki.servarr.com/radarr/troubleshooting#logging-and-log-files) + Trace Logs (Settings → General → Logging → Trace) ***Generally speaking, all bug reports MUST have trace logs provided.*** Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. Additionally, any additional info? Screenshots? References? Anything that will give us more context about the issue you are encountering! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 71a20ab313..31e967e309 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - - name: Support via Discord - url: https://radarr.video/discord - about: Chat with users and devs on support and setup related topics. + - name: GitHub Discussions + url: https://github.com/cheir-mneme/aletheia/discussions + about: Ask questions and discuss ideas. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 6fe6bc0229..12e9ce3484 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,5 +1,5 @@ name: Feature Request -description: 'Suggest an idea for Radarr' +description: 'Suggest an idea for Aletheia' labels: ['Type: Feature Request', 'Status: Needs Triage'] body: - type: checkboxes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a46e92a807..54a2f9415e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,17 +81,44 @@ dotnet msbuild -restore src/Radarr.sln -p:Configuration=Debug -p:Platform=Posix ## Contributing Code -- Make meaningful commits +- Make meaningful commits using conventional commit format - Add tests (unit/integration) for new features - Commit with \*nix line endings for consistency - Use 4 spaces instead of tabs - Match existing code patterns and style +## Commit Format + +Use [Conventional Commits](https://www.conventionalcommits.org/): + +``` +type(scope): description +``` + +**Types:** +- `feat`: New feature +- `fix`: Bug fix +- `docs`: Documentation only +- `refactor`: Code change (no behavior change) +- `test`: Test additions/changes +- `chore`: Build, deps, config + +**Scope (optional):** audiobook, metadata, ui, database, api, indexer + +**Examples:** +``` +feat(audiobook): add narrator matching logic +fix(metadata): handle API timeout gracefully +refactor(database): extract MediaItem base class +docs: update installation instructions +``` + ## Pull Requesting - Only make pull requests to `develop`, never `master` -- Use meaningful feature branch names (what is being added/fixed) +- Use meaningful feature branch names: `feature/`, `fix/`, `refactor/`, `docs/` - Each PR should contain related changes (one feature/bug fix per PR) +- Fill out the PR template completely ## Unit Testing