Skip to content

Commit 41c24a9

Browse files
committed
add: commit-message documentation and update exclude patterns in config.yml
1 parent 8992421 commit 41c24a9

File tree

2 files changed

+73
-1
lines changed

2 files changed

+73
-1
lines changed

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "Anreicherung und Publikation von Annotationsdatensets auf Repositorien"
55
author: Derya Demir & Matthias Grotkopp
66
logo: assets/logo.jpg
77
copyright: "2025, QUADRIGA"
8-
exclude_patterns: [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints", conda, venv, .venv, README.md, LICENSE.md, .github, "**Reviewbogen.md", Checkliste_Finalisierung.md]
8+
exclude_patterns: [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints", conda, venv, .venv, README.md, LICENSE.md, .github, "**Reviewbogen.md", Checkliste_Finalisierung.md, commit_message_dokumentation.md]
99

1010
# Force re-execution of notebooks on each build.
1111
# See https://jupyterbook.org/content/execute.html

commit_message_dokumentation.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Commit Guidelines für Bewegtes-Bild-Fallstudie-3
2+
3+
Dieses Dokument definiert die Standards für Commit-Message, die konkret in unserem Repositorium genutzt werden. Died Verwendung konsistenter Commit-Messages verbesset die Lesbarkeit der Git-Historie und erleichtert das Verständnis von Änderungen.
4+
5+
Für allgemeine Commit-Standards besuchen Sie bitte: <a href="https://www.conventionalcommits.org/en/v1.0.0/" class="external-link" target="_blank">conventionalcommits.org</a>
6+
7+
8+
```none
9+
<typ>: <kurze beschreibung>
10+
```
11+
## Verwendete Commit-Typen
12+
13+
`feat`
14+
15+
**Verwendung**: Neue Features, Funktionen oder Verbesserungen
16+
17+
**Beispiele**:
18+
19+
```none
20+
feat: implement search functionality
21+
feat: add support for dark mode
22+
```
23+
24+
`fix`
25+
**Verwendung**: Behebung von technischen Fehlern und Bugs
26+
27+
**Beispiele**:
28+
29+
```none
30+
fix: resolve overwritten files
31+
fix: also commit CITATION.cff if changed
32+
```
33+
34+
`docs`
35+
36+
**Verwendung**: Inhaltliche Änderungen sowie Änderungen an Dokumentation und Markdown-Dateien, einschließlich Tippfehlern
37+
38+
**Beispiele**:
39+
40+
```none
41+
docs: fix typo in README.md
42+
docs: exchange cross-target link in 'epilog'
43+
```
44+
45+
`add`
46+
47+
**Verwendung**: Hinzufügen neuer Dateien, Assets oder Ressourcen
48+
49+
**Beispiele**:
50+
51+
```none
52+
add: new logo image
53+
add: orcid-image link as button
54+
```
55+
56+
`update`
57+
58+
**Verwendung**: Kleine allgemeine Änderungen und Neuerungen, die nicht in andere Kategorien passen
59+
60+
**Beispiele**:
61+
62+
```none
63+
update: improve button styling
64+
update: upload new logo image
65+
```
66+
67+
## Richtlinien
68+
69+
* Verwendung des Imperativs (z.B. "add" statt "added")
70+
* Verwendung von Kleinbuchstaben mit Außnahme von spezifischen Dateinamen (z.B. README.md)
71+
* Formulierung kurzer und prägnanter Aussagen
72+
* Verwendung von Englisch für Konsistenz

0 commit comments

Comments
 (0)