Du möchstest also Code zu BookWyrm hinzufügen: Das ist klasse! Wenn es ein offenes Problem gibt, dass du beheben möchtest, ist es hilfreich, das Problem zu kommentieren, damit die Arbeit nicht dupliziert wird. Versuche den Umfang von Pull Requests kleinzuhalten und konzentriere dich auf ein einzelnes Thema. Auf diese Weise ist es einfacher zu überprüfen und wenn ein Teil Änderungen braucht, wird er die anderen Teile nicht aufhalten.
Wenn du nicht weißt, wie man etwas fixt oder etwas nicht schaffst: Kein Problem. Hinterlasse einen Kommentar im Pull Request und wir versuchen es, herauszufinden 💖.
Pull-Anfragen müssen alle automatisierten Prüfungen bestehen, bevor sie übernommen werden können - dazu gehören Stil-Prüfungen, globale Linter, eine Sicherheitsprüfung und Unit-Tests.
Wir verwenden EditorConfig, um konsistente Einrückungen und Zeilenenden zu erhalten.
BookWyrm verwendet den Black Code-Formatierer, um die Python Codebasis konsistent zu gestalten. Alle neuen Pull-Requests werden mit GitHub-Aktionen überprüft und Sie können Code-Stilprobleme automatisch beheben, indem du ./bw-dev black ausführst
Code wird auch mit Pylint mittels GitHub-Aktionen überprüft. Pylint-Warnungen müssen bearbeitet werden, bevor Pull-Anfragen übernommen werden, aber es liegt im Ermessen, ob der Vorschlag verwendet werden oder die Warnung unterdrückt werden sollte. Um eine Warnung zu unterdrücken, füge einen Kommentar am Ende oder über der Zeile mit der Warnung hinzu: # pylint: disable=Name-der-Warnung
Dein Pull-Request wird auch durch den curlylint-Linter für Django-Templates überprüft.
Wir verwenden stylelint, um alle CSS-Regeln zu überprüfen. Wie bei Pylint kannst du styelint für eine bestimmte Regel deaktivieren, aber du benötigst dafür eine gute Rechtfertigung.
ESLint überprüft alle von Ihnen vorgenommenen JavaScript-Änderungen. Falls ESLint dein funktionierendes JavaScript nicht mag, überprüfe die Linter-Meldung auf das genaue Problem.
Bookwyrm hat zum Ziel, so umfassend und zugänglich wie möglich zu sein.
Überprüfen Sie die Checkliste für inklusives Web Design bevor du einen Pull-Reuqest erstellst. Für Barrierefreiheit ist A11Y-101 ebenfalls eine nützliche Quelle. Weitere Informationen darüber, wie du deine Seitenvorlagen mehrsprachig erstellst, findest du im Abschnitt Übersetzungen.
Einige besondere Dinge, die Bookwyrm-Beitragende für nützlich erachtet haben, sind:
input[type="checkbox"] oder input[type="radio"] in <label><label>platzierst, sollte das <label> nach dem Element platziert werden, auf das es sich bezieht<button> Element für alles, was existiert, um eine JavaScript-Aktion auszulösen (z.B. ein Formular verstecken oder enthüllen) oder eine POST-Anfrage senden (z.B. ein Formular übermitteln)<a>-Element für alles, was eine GET-Anfrage auslöst. Normalerweise sollte ein Ankerelement (<a>) nicht als Button (class="button") dargestellt werden, obwohl es einige Ausnahmen gibt, wie z. B. "Abbrechen"-Buttons. Falls Sie Zweifel haben, fragen Sie in Ihrer Pull-Anfrage um Rat