mirror of
https://github.com/Radarr/Radarr
synced 2026-01-24 00:13:43 +01:00
docs: update community standards with conventional commits and Aletheia branding
This commit is contained in:
parent
09a7180966
commit
772baf7b0b
4 changed files with 37 additions and 10 deletions
8
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
8
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -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!
|
||||
|
|
|
|||
6
.github/ISSUE_TEMPLATE/config.yml
vendored
6
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -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.
|
||||
|
|
|
|||
2
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
2
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue