|
| 1 | +# Profile teilen |
| 2 | + |
| 3 | +Hast du eine Profil-Sammlung, die andere nützlich finden könnten? So fügst du sie dem Showcase hinzu. |
| 4 | + |
| 5 | +## Voraussetzungen |
| 6 | + |
| 7 | +- [amoxide](https://github.com/sassman/amoxide-rs) installiert |
| 8 | +- Ein [GitHub](https://github.com)-Konto |
| 9 | + |
| 10 | +## Schritt für Schritt |
| 11 | + |
| 12 | +Angenommen, dein GitHub-Nutzername ist **john** und du möchtest deine Git-Profile für konventionelle Commits teilen. |
| 13 | + |
| 14 | +### 1. Repository forken |
| 15 | + |
| 16 | +Gehe zu [github.com/sassman/amoxide-rs](https://github.com/sassman/amoxide-rs) und klicke auf **Fork** (oben rechts). Dadurch wird deine eigene Kopie unter `github.com/john/amoxide-rs` erstellt. |
| 17 | + |
| 18 | +### 2. Fork klonen |
| 19 | + |
| 20 | +```bash |
| 21 | +git clone git@github.com:john/amoxide-rs.git |
| 22 | +cd amoxide-rs |
| 23 | +``` |
| 24 | + |
| 25 | +### 3. Branch erstellen |
| 26 | + |
| 27 | +```bash |
| 28 | +git checkout -b community/john-git-conventional |
| 29 | +``` |
| 30 | + |
| 31 | +### 4. Vorlage kopieren |
| 32 | + |
| 33 | +```bash |
| 34 | +cp -r community/TEMPLATE community/john-git-conventional |
| 35 | +``` |
| 36 | + |
| 37 | +Das ergibt: |
| 38 | + |
| 39 | +``` |
| 40 | +community/john-git-conventional/ |
| 41 | +├── README.md ← bearbeite diese Datei |
| 42 | +└── profiles.toml ← ersetze mit deinem Export |
| 43 | +``` |
| 44 | + |
| 45 | +### 5. Profile exportieren |
| 46 | + |
| 47 | +Ersetze die Vorlagen-`profiles.toml` mit deinem eigentlichen Export: |
| 48 | + |
| 49 | +```bash |
| 50 | +am export -p git-conventional > community/john-git-conventional/profiles.toml |
| 51 | +``` |
| 52 | + |
| 53 | +Oder exportiere mehrere Profile: |
| 54 | + |
| 55 | +```bash |
| 56 | +am export -p git -p git-conventional > community/john-git-conventional/profiles.toml |
| 57 | +``` |
| 58 | + |
| 59 | +### 6. README bearbeiten |
| 60 | + |
| 61 | +Öffne `community/john-git-conventional/README.md` und fülle das Frontmatter aus: |
| 62 | + |
| 63 | +```yaml |
| 64 | +--- |
| 65 | +author: john |
| 66 | +description: Git-Aliase für konventionelle Commit-Workflows |
| 67 | +category: git |
| 68 | +tags: [git, conventional-commits, workflow] |
| 69 | +profiles: [git, git-conventional] |
| 70 | +--- |
| 71 | +``` |
| 72 | + |
| 73 | +Schreibe dann ein paar Sätze darüber, was deine Aliase tun, wie du sie verwendest und welche Tools installiert sein müssen. |
| 74 | + |
| 75 | +::: details Frontmatter-Referenz |
| 76 | +| Feld | Pflichtfeld | Beschreibung | |
| 77 | +|------|-------------|--------------| |
| 78 | +| `author` | ja | Dein GitHub-Nutzername | |
| 79 | +| `description` | ja | Einzeilige Zusammenfassung (wird auf der Kachel angezeigt) | |
| 80 | +| `category` | ja | Eines von: `git`, `docker`, `rust`, `k8s`, `python`, `node`, `misc` | |
| 81 | +| `tags` | ja | Array von Stichwörtern für die Filterung | |
| 82 | +| `profiles` | ja | Profilnamen in deiner `profiles.toml` | |
| 83 | +| `shell` | nein | Nur setzen, wenn deine Aliase shell-spezifische Syntax verwenden (z. B. `fish`) | |
| 84 | +::: |
| 85 | + |
| 86 | +### 7. Testen |
| 87 | + |
| 88 | +Stelle sicher, dass der Import funktioniert: |
| 89 | + |
| 90 | +```bash |
| 91 | +cat community/john-git-conventional/profiles.toml | am import --yes |
| 92 | +``` |
| 93 | + |
| 94 | +### 8. Committen und pushen |
| 95 | + |
| 96 | +```bash |
| 97 | +git add community/john-git-conventional/ |
| 98 | +git commit -m "community: add john-git-conventional" |
| 99 | +git push origin community/john-git-conventional |
| 100 | +``` |
| 101 | + |
| 102 | +### 9. Pull Request öffnen |
| 103 | + |
| 104 | +Gehe zu deinem Fork auf GitHub — du siehst ein Banner zum Erstellen eines Pull Requests. Klicke darauf und wähle die **Community Profile** PR-Vorlage. |
| 105 | + |
| 106 | +Die Checkliste führt dich durch das Notwendige: |
| 107 | + |
| 108 | +- [ ] Ordner mit dem Namen `community/john-git-conventional/` |
| 109 | +- [ ] `profiles.toml` ist eine gültige `am export`-Ausgabe |
| 110 | +- [ ] `README.md` hat das erforderliche Frontmatter |
| 111 | +- [ ] Nur Dateien in deinem eigenen Ordner wurden geändert |
| 112 | +- [ ] Import lokal getestet |
| 113 | + |
| 114 | +Dein Beitrag erscheint nach der Überprüfung im Showcase. |
| 115 | + |
| 116 | +## Regeln |
| 117 | + |
| 118 | +- Füge nur Dateien in deinem eigenen Ordner hinzu oder ändere sie |
| 119 | +- Ein Ordner pro Alias-Sammlung (mehrere Profile in einer `profiles.toml` sind in Ordnung) |
| 120 | +- Für eine zweite Sammlung erstelle einen zweiten Ordner (z. B. `john-docker-compose`) |
| 121 | + |
| 122 | +## Was macht einen guten Beitrag aus? |
| 123 | + |
| 124 | +- **Nützlich für andere** — Aliase, die häufige Workflows lösen |
| 125 | +- **Gut dokumentiert** — erkläre, was jeder Alias tut |
| 126 | +- **In sich geschlossen** — weise auf Abhängigkeiten hin |
| 127 | +- **Getestet** — überprüfe, dass der Import funktioniert |
| 128 | + |
| 129 | +::: warning Sicherheit |
| 130 | +Alle Einsendungen werden vor dem Zusammenführen geprüft. Wir prüfen auf verdächtige Inhalte, aber du solltest Aliase immer selbst inspizieren, bevor du sie importierst — auch aus diesem Showcase. |
| 131 | +::: |
0 commit comments