matt/database
1
0
Fork 0
mirror of https://github.com/Dictionarry-Hub/database.git synced 2025-12-10 15:57:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add CONTRIBUTING.md with commit message guidelines and structure

Browse Source
This commit is contained in:
Sam Chau
2025-01-11 04:52:49 +10:30
parent d9248500cb
commit b81a191407
1 changed files with 31 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,31 @@
# Contributing
## Commit Message Format
```
type(component): Description
[Optional body]
```
## Types and Components
### Change Types
| Type | Purpose | Example |
| -------- | -------------------------------------------------- | -------------------------------------------------- |
| `create` | Building entirely new components or systems | `create(profile): 2160p Remux quality profile` |
| `add` | Adding entries to existing systems | `add(format): de[42] as Tier 4 GPPi group` |
| `tweak` | Fine-tuning and adjustments to existing components | `tweak(format): Better h265 parsing for 1080p WEB` |
| `fix` | Corrections and bug fixes | `fix(regex): Required negation for remux pattern` |
### Components
| Component | Purpose | Includes |
| --------- | --------------------------- | -------------------------------------------------------------------------------------------------------- |
| `format` | Changes to Custom Formats | - Format definitions<br>- Scoring adjustments<br>- Release group configurations<br>- Quality preferences |
| `regex` | Changes to regex patterns | - Pattern definitions<br>- Matching logic<br>- Parser improvements<br>- Detection rules |
| `profile` | Changes to Quality Profiles | - Profile creation/modification<br>- Quality settings<br>- Scoring systems<br>- Default configurations |
## Contributing with Profilarr
Profilarr was built specifically to maintain these standards, making it our recommended way to contribute. While we welcome external contributions, please ensure they strictly follow these commit guidelines.