„Issues“ ändern
parent
be7f7e4851
commit
c2c9507423
215
Issues.md
215
Issues.md
@ -1,107 +1,108 @@
|
||||
# Fehler & Funktionen
|
||||
|
||||
- [Fehler melden](#fehler-melden)
|
||||
- [Neue Funktion vorschlagen](#neue-funktion-vorschlagen)
|
||||
- [Befehl](#befehl)
|
||||
- [Modul](#modul)
|
||||
|
||||
## Fehler melden
|
||||
|
||||
Um einen Fehler zu melden, müssen Sie [hier](new-issue) klicken.
|
||||
|
||||
Dazu sollten Sie folgendes beachten:
|
||||
|
||||
Alle Einträge sollten mit Markdown Formatiert sein. Dazu bieten wir im Folgenden Text auch verschiedene Beispiele: [Befehle](#befehle), [Module](#module).
|
||||
|
||||
Ein issue sollte immer eine Funktion aus Sicht des Benutzers beschreiben. Bsp.:
|
||||
|
||||
```text
|
||||
Ein Benutzer soll sich an dem Portal anmelden können.
|
||||
Dabei werden E-Mail und Passwort abgefragt.
|
||||
```
|
||||
|
||||
Fehler sollten hingegen möglichst genau beschrieben sein. Bsp.:
|
||||
|
||||
```text
|
||||
Der Befehl ```!get xp``` gibt nicht den richtigen Wert zurück.
|
||||
Ich bekomme immer ca. 30 xp weniger angezeigt als ich eigentlich habe.
|
||||
Zu diesem Zeitpunkt müsste ich 42 xp haben, jedoch werden mir nur 12 angezeigt.
|
||||
Ich komme darauf, dass ich ca. 42 haben müsste, da ich das entsprechende Level habe.
|
||||
```
|
||||
|
||||
Der Text sieht dann durch Markdown so aus:
|
||||
|
||||
Der Befehl ```!get xp``` gibt nicht den richtigen Wert zurück.
|
||||
Ich bekomme immer ca. 30 xp weniger angezeigt als ich eigentlich habe.
|
||||
|
||||
## Neue Funktion vorschlagen
|
||||
|
||||
Sie sollten beim Vorschlagen neuer Funktionen die Beispiele ([Befehle](#befehle), [Module](#module)) verwenden!
|
||||
|
||||
Ein Modul ist eine zusammenfassungen von Funktionen und Befehlen innerhalb eines Themas, z.B. Ein ```Verwarnungssystem```.
|
||||
|
||||
Wenn Sie eine einfache neue Funktion haben wollen, jedoch keine Befehle oder ein Modul zuordnen können, können Sie in einem einfachen Text verfassen, was Sie sich unter der neuen Funktion vorstellen. Wir kümmern uns um den Rest.
|
||||
|
||||
### Befehl
|
||||
|
||||
Kopieren Sie dies Beispiel und tragen Sie unter den Überschriften die zutreffenden Begriffe ein.
|
||||
Entfernen Sie die Begriffe, die nicht zutreffen!
|
||||
|
||||
```text
|
||||
##### Befehl:
|
||||
|
||||
!g befehl
|
||||
|
||||
##### Parameter:
|
||||
|
||||
* parameter (type)
|
||||
|
||||
##### Reaktion:
|
||||
|
||||
Beschreibung der Reaktion
|
||||
|
||||
##### Berechtigungen:
|
||||
|
||||
* Admin
|
||||
* Moderator
|
||||
* Keine
|
||||
|
||||
##### Neue Daten zum Speichern:
|
||||
|
||||
* Keine
|
||||
|
||||
##### Aufwand:
|
||||
|
||||
Gering
|
||||
Mittel
|
||||
Hoch
|
||||
sehr hoch
|
||||
```
|
||||
|
||||
### Modul
|
||||
|
||||
Kopieren Sie dies Beispiel und tragen Sie unter den Überschriften die zutreffenden Begriffe ein.
|
||||
Entfernen Sie die Begriffe, die nicht zutreffen!
|
||||
|
||||
```text
|
||||
##### Beschreibung:
|
||||
|
||||
Beschreibung des Moduls bzw. Erklärung und Auflistung der Funktionen.
|
||||
|
||||
##### Befehle:
|
||||
|
||||
* befehl parameter
|
||||
|
||||
##### Neue Daten zum Speichern:
|
||||
|
||||
* Keine
|
||||
|
||||
##### Aufwand:
|
||||
|
||||
Gering
|
||||
Mittel
|
||||
Hoch
|
||||
sehr hoch
|
||||
```
|
||||
|
||||
[new-issue]: https://git.sh-edraft.de/sh-edraft.de/kd_discord_bot/issues/new
|
||||
# Fehler & Funktionen
|
||||
|
||||
- [Fehler melden](#fehler-melden)
|
||||
- [Neue Funktion vorschlagen](#neue-funktion-vorschlagen)
|
||||
- [Befehl](#befehl)
|
||||
- [Modul](#modul)
|
||||
|
||||
## Fehler melden
|
||||
|
||||
Um einen Fehler zu melden, müssen Sie [hier](new-issue) klicken.
|
||||
|
||||
Dazu sollten Sie folgendes beachten:
|
||||
|
||||
Alle Einträge sollten mit Markdown Formatiert sein. Dazu bieten wir im Folgenden Text auch verschiedene Beispiele: [Befehle](#befehle), [Module](#module).
|
||||
|
||||
Ein issue sollte immer eine Funktion aus Sicht des Benutzers beschreiben. Bsp.:
|
||||
|
||||
```text
|
||||
Ein Benutzer soll sich an dem Portal anmelden können.
|
||||
Dabei werden E-Mail und Passwort abgefragt.
|
||||
```
|
||||
|
||||
Fehler sollten hingegen möglichst genau beschrieben sein. Bsp.:
|
||||
|
||||
```text
|
||||
Der Befehl ```!get xp``` gibt nicht den richtigen Wert zurück.
|
||||
Ich bekomme immer ca. 30 xp weniger angezeigt als ich eigentlich habe.
|
||||
Zu diesem Zeitpunkt müsste ich 42 xp haben, jedoch werden mir nur 12 angezeigt.
|
||||
Ich komme darauf, dass ich ca. 42 haben müsste, da ich das entsprechende Level habe.
|
||||
```
|
||||
|
||||
Der Text sieht dann durch Markdown so aus:
|
||||
|
||||
Der Befehl ```!get xp``` gibt nicht den richtigen Wert zurück.
|
||||
Ich bekomme immer ca. 30 xp weniger angezeigt als ich eigentlich habe.
|
||||
|
||||
## Neue Funktion vorschlagen
|
||||
|
||||
Sie sollten beim Vorschlagen neuer Funktionen die Beispiele ([Befehle](#befehle), [Module](#module)) verwenden!
|
||||
|
||||
Ein Modul ist eine zusammenfassungen von Funktionen und Befehlen innerhalb eines Themas, z.B. Ein ```Verwarnungssystem```.
|
||||
|
||||
Wenn Sie eine einfache neue Funktion haben wollen, jedoch keine Befehle oder ein Modul zuordnen können, können Sie in einem einfachen Text verfassen, was Sie sich unter der neuen Funktion vorstellen. Wir kümmern uns um den Rest.
|
||||
|
||||
### Befehl
|
||||
|
||||
Kopieren Sie dies Beispiel und tragen Sie unter den Überschriften die zutreffenden Begriffe ein.
|
||||
Entfernen Sie die Begriffe, die nicht zutreffen!
|
||||
|
||||
```text
|
||||
##### Befehl:
|
||||
|
||||
/befehl
|
||||
!k befehl
|
||||
|
||||
##### Parameter:
|
||||
|
||||
* parameter (type)
|
||||
|
||||
##### Reaktion:
|
||||
|
||||
Beschreibung der Reaktion
|
||||
|
||||
##### Berechtigungen:
|
||||
|
||||
* Admin
|
||||
* Moderator
|
||||
* Keine
|
||||
|
||||
##### Neue Daten zum Speichern:
|
||||
|
||||
* Keine
|
||||
|
||||
##### Aufwand:
|
||||
|
||||
Gering
|
||||
Mittel
|
||||
Hoch
|
||||
sehr hoch
|
||||
```
|
||||
|
||||
### Modul
|
||||
|
||||
Kopieren Sie dies Beispiel und tragen Sie unter den Überschriften die zutreffenden Begriffe ein.
|
||||
Entfernen Sie die Begriffe, die nicht zutreffen!
|
||||
|
||||
```text
|
||||
##### Beschreibung:
|
||||
|
||||
Beschreibung des Moduls bzw. Erklärung und Auflistung der Funktionen.
|
||||
|
||||
##### Befehle:
|
||||
|
||||
* befehl parameter
|
||||
|
||||
##### Neue Daten zum Speichern:
|
||||
|
||||
* Keine
|
||||
|
||||
##### Aufwand:
|
||||
|
||||
Gering
|
||||
Mittel
|
||||
Hoch
|
||||
sehr hoch
|
||||
```
|
||||
|
||||
[new-issue]: https://git.sh-edraft.de/sh-edraft.de/kd_discord_bot/issues/new
|
||||
|
||||
Loading…
Reference in New Issue
Block a user