Zum Inhalt

Beteiligt Euch am gofoss.net Projekt!

Zum gofoss.net Projekt beitragen

Herzlich willkommen! gofoss.net ist ein freies und quelloffenes Projekt. Alle haben somit die Gelegenheit, den Code der Website zu überprüfen und Verbesserungen vorzuschlagen. Beteiligt Euch, es gibt zahlreiche Möglichkeiten, um mitzumachen!

  • Verbessert den Inhalt, fügt neue Funktionen hinzu, behebt Fehler
  • Erhöht die Benutzerfreundlichkeit, entwerft neue Grafiken
  • Helft uns beim Übersetzen
  • Moderiert Diskussionen
  • Pflegt den Code

Leitlinien für Beiträge

Nehmt Kontakt auf

Falls Ihr Fragen habt oder diskutieren möchtet, besteht kein Bedarf ein sogenanntes Issue auf GitLab anzulegen. Meldet Euch einfach über die sozialen Medien bei uns:

   Folgt @gofoss_today auf Twitter

   Folgt @don_atoms auf Mastodon

   Schreibt @gofosstoday auf Reddit an

   Schreibt @gofoss auf Lemmy an

   Tretet unserem Matrix-Chat bei

   Schickt uns eine E-Mail

Öffnet eine GitLab-Issue

Anweisungen Beschreibung
Stellt ein paar Nachforschungen an • Sucht nach ähnlichen Beiträgen, bevor Ihr selbst einen einreicht
• Es ist gut möglich, dass jemand anderes bereits das gleiche Problem oder den gleichen Funktionsvorschlag hatte
Nehmt Kontakt mit der gofoss.net-Gemeinschaft auf
Sucht im sogenannten Issue Tracker
Schaut Euch die Roadmap an
Legt ein Issue an • Falls Eure Nachforschungen erfolglos bleiben, könnt Ihr ein Issue anlegen
Sign in to GitLab
• Öffnet den gofoss.net Issue Tracker
• Klickt auf die New Issue-Schaltfläche
• Gebt einen Titel an
• Wählt die richtige Vorlage (auf Englisch, Template) aus:

content_request: Vorschläge für neue oder verbesserte Inhalte, z. B. neue Software, fehlende oder falsche Informationen, Rechtschreib- oder Grammatikfehler, Verbesserung der Lesbarkeit usw.

feature_request: Vorschläge für neue Webseiten-Funktionen, z. B. verbesserte Benutzerführung, verbessertes Erscheinungsbild, neue Graphiken, Dunkelmodus usw.

bug_report: unerwartetes Verhalten der Webseite, z. B. fehlerhafte Links, Probleme beim Laden auf bestimmten Geräten usw.
Nehmt am Überprüfungsverfahren teil • Alle Issues werden öffentlich diskutiert und überprüft
• Verfolgt aufmerksam die Diskussionen zu Euren Issues
• Beantwortet mögliche Fragen und überprüft Beiträge anderer
• Das ist genauso wertvoll wie ein Eigenbeitrag
Richtet E-Mail-Benachrichtigungen ein, um auf dem Laufenden zu bleiben
Warten, bis das Issue gelöst oder geschlossen ist • Wir tun unser Bestes, um Issues schnell zu schließen
• Im Gegenzug bitten wir Euch, für klärende Fragen oder Korrekturen verfügbar zu sein
• Sollten wir keinerlei Rückmeldung erhalten, behalten wir uns das Recht vor offene Issues zu schließen

Bearbeitet laufende GitLab-Issues

Arbeitsabläufe für Verzweigungen und Issues

Issue-Verzweigung

Verzweigung Grundsätze
main • Der main-Zweig (auf Englisch branch) ist der Produktionszweig
• Jegliche Änderung (auf Englisch commit) am main-Zweig wird automatisch von GitLab an Netlify übermittelt
• Der main-Zweig ist daher geschützt
• Er ist ausschließlich für gofoss.net Team-Mitglieder, die sogenannten Maintainer, zugänglich
dev • Der dev-Zweig wird aus dem main-Zweig erzeugt
• Hier werden neue Inhalte, Funktionen sowie Fehlerbehebungen entwickelt und getestet
• Der dev-Zweig ist ausschließlich für maintainers im gofoss.net-Team zugänglich
• Der dev-Zweig wird mit dem main-Zweig zusammengeführt (auf Englisch merged), wenn er für die Veröffentlichung bereit ist
issue • Jedem Issue sollte ein eigener Zweig zugewiesen werden
Issue-Zweige werden aus dem dev-Zweig erzeugt
• Sobald die Arbeit an einem Issue abgeschlossen ist, wird der Issue-Zweig wieder mit dem dev-Zweig zusammengeführt
Issue-Zweige interagieren daher nie direkt mit dem main-Zweig
• Sowohl gofoss.net-Maintainer als auch externe Mitwirkende können an Issue-Zweigen arbeiten

Arbeitsabläufe für Gabelungen

Arbeitsabläufe für Gabelungen

Anweisungen Beschreibung
Wählt ein Issue, an dem Ihr arbeiten möchtet Sucht im Tracker nach Issues, die mit accepting_merge_requests vermerkt sind
• Diese Issues sind für externe Beiträge offen
• Setzt Euch mit dem gofoss.net-Team in Verbindung, bevor Ihr mit der Arbeit an einem Issue beginnt
• Hinterlasst entweder einen Kommentar zu dem Issue, an dem Ihr arbeiten möchtet
• Oder schickt uns eine Nachricht auf Mastodon, Twitter oder email
• Es gibt auch einen Matrix-Chat, in dem sich die gofoss.net-Entwickler aufhalten (nur mit Einladung)
• Wartet, bis jemand aus dem gofoss.net-Team Eure Beitragsanfrage bestätigt hat
Gabelt (forkt), klont und synchronisiert das gofoss.net-Repository Meldet Euch bei GitLab an
• Ruft das gofoss.net Projekt auf
• Klickt auf die Fork-Schaltfläche
• Dadurch wird eine Kopie des gofoss.net-Projekts in Eurem eigenen GitLab-Repository erstellt
• Öffnet auf Eurem lokalen Rechner ein Terminal und legt einen Projektordner an:
mkdir ~/git_projects
• Klont Euer GitLab repository:
cd ~/git_projects
git clone https://gitlab.com/<YOUR_USERNAME>/gofoss.git
• Wechselt zur lokalen Kopie Eures Repositorys:
cd ~/git_projects/gofoss
• Erstellt eine Verknüpfung mit dem vorgelagerten gofoss.net-Projekt, um Euren Fork auf dem neuesten Stand zu halten:
git remote add upstream https://gitlab.com/curlycrixus/gofoss.git
• Gleicht Euch regelmäßig mit dem dev-Zweig des vorgelagerten Projekts ab:
cd ~/git_projects/gofoss
git fetch upstream
git checkout dev
git pull upstream dev
git push origin dev
• Es kann sonst vorkommen, dass Eure Zusammenführungsanfrage aufgrund eines veralteten Forks abgelehnt wird
Richtet die Entwicklungsumgebung ein • Gebt Eure GitLab-Daten an:
git config user.email "<USER>@example.com"
git config user.name "<USERNAME>"
• Installiert die aktuellste Python-Version sowie Abhängigkeiten:
sudo apt install python3 python3-pip
• Stellt sicher, dass die Python-Version 3 installiert ist:
python3 --version
• Installt Mkdocs:
sudo apt install mkdocs
• Installt Material für Mkdocs:
pip install mkdocs-material
• Installt die Mehrsprachen-Erweiterung:
pip install mkdocs-static-i18n
• Installiert Abhängigkeiten:
pip install -r requirements.txt
Committet lokal und pusht an das Remote-Repository • Erstellt einen neuen Issue-Zweig unter Beachtung der Namenskonvention [content/feature/bug]-[#IssueID]-[Kurzbeschreibung]
• Hier ein Beispiel:
git checkout -b feature-#72-add-dark-mode
• Wechselt in den neuen Zweig:
git checkout feature-#72-add-dark-mode
• Beginnt zu Programmieren: fügt Inhalte und Funktionen hinzu oder behebt Fehler
• Lokale Änderungen können im Browser unter localhost:8000 mit folgendem Befehl angezeigt werden:
mkdocs serve
• Sobald alles wie erwartet funktioniert, könnt Ihr den Code in den sogenannten Staging-Bereich einfügen:
git add .
• Bestätigt die Änderungen und fügt einen eindeutigen Kommentar hinzu:
git commit -m "<CLEAR COMMENT>"
• Übermittelt abschließen den Issue-Zweig an Euer Remote-Repository:
git push -u origin feature-#72-add-dark-mode
Öffnet eine Zusammenführungsanfrage (Merge Request) Meldet Euch bei GitLab an
• Ruft https://gitlab.com/<YOUR_USERNAME>/gofoss/-/merge_requests auf
• Klickt auf die New merge request-Schaltfläche
• Wählt den Quellzweig aus: <USERNAME>/gofoss/feature-#72-add-dark-mode
• Wählt den Zielzweig aus: curlycrixus/gofoss/dev
• Klickt auf die Compare branches and continue-Schaltfläche
• Wählt die merge_request Vorlage
• Gebt eindeutige Titel und Beschreibungen für Euren Zusammenführungsantrag an
• Wählt die Option Delete source branch when merge request is accepted
• Klickt auf die Create merge request-Schaltfläche
Nehmt am Überprüfungsverfahren teil • Alle Zusammenführungsanfragen werden öffentlich diskutiert und geprüft
• Verfolgt aufmerksam die Diskussionen zu Eurer Zusammenführungsanfrage
• Beantwortet mögliche Fragen
Richtet E-Mail-Benachrichtigungen ein, um auf dem Laufenden zu bleiben
Wartet auf die Bestätigung • Ein gofoss.net-Maintainer wird Euren Issue-Zweig in sein lokales Repository kopieren (pullen)
• Euer Beitrag wird dann geprüft
• Falls der Maintainer Kommentare haben sollte, solltet Ihr Eure Zusammenführungsanfrage anpassen
• Falls alles in Ordnung ist, führt der gofoss.net-Maintainer Euren Issue-Zweig mit seinem lokalen dev-Zweig zusammen und übermittelt die Änderungen an das gofoss.net-Repository
• Damit ist Euer Beitrag Teil des gofoss.net-Projekts!
• Die anderen EntwicklerInnen sollten sich nun mit dem gofoss.net-Repository synchronisieren
Entfernt den Zweig • Nachdem Eure Zusammenführungsanfrage übernommen wurde, sollte der Issue-Zweig feature-#72-add-dark-mode gelöscht worden sein
• Falls nicht, solltet Ihr ihn händisch entfernen
• Ihr könnt die Änderungen nun sicher aus dem vorgelagerten Repository übernehmen (pullen)`
Lizenz Indem Ihr zu gofoss.net beitragt, stimmt Ihr zu, dass Eure Beiträge unter der AGPLv3 veröffentlicht werden.

Verzeichnisstruktur

Achtet bitte darauf, die Verzeichnisstruktur beizubehalten:

.
├─ .gitlab/             # Vorlagen für *Issues* und Zusammenführungsanfragen (*Merge Requests*)
│
├─ docs/
│  │
│  ├─ assets/
│  │  └─ css/           # Stylesheets (.css), Schriftarten (.ttf) & Symboldateien (.svg)
│  │  └─ echarts/       # E-Chart Dateien (.html, .min.js)
│  │  └─ img/           # Bilddateien (.svg, .png, etc.)
│  │
│  └─ *.xyz.md          # mehrsprachige Markdown-Dateien (.en.md, .fr.md, .de.md, etc.)
│
├─ overrides/           # Themenerweiterungen (home_xyz.html, main.html, overrides.xyz.min.css)
│
├─ LICENSE              # Mkdocs-Material-Lizenz
│
├─ netlify.toml         # Anleitung zur Netlify-Implementierung
│
├─ requirements.toml    # Abhängigkeiten
│
├─ runtime.txt          # Python-Version für die Netlify-Implementierung
│
└─ mkdocs.yml           # Mkdocs-Konfigurationsdatei
Helft mit beim Übersetzen

Anweisungen Beschreibung
Tretet einer Verteilerliste bei Falls Ihr eine oder mehrere der veröffentlichten Sprachen korrekt beherrscht und über Grundkenntnisse der Markdown-Syntax verfügt, könnt Ihr gerne einer der folgenden Verteilerlisten beitreten:
EN ‣ FR Übersetzungsteam (Framasoft-Gemeinschaft)
EN ‣ DE Übersetzungsteam
EN ‣ ES Übersetzungsteam
EN ‣ PL Übersetzungsteam
Tauscht Euch mit anderen ÜbersetzerInnen aus Es gibt ebenfalls einen Matrix-Chat, in dem sich die ÜbersetzerInnen austauschen, koordinieren und beraten.
Erhaltet Zugang zu den Übersetzungsdateien Alle ÜbersetzerInnen erhalten einen Link, um auf die Projektdateien zugreifen zu können.
Arbeitet mit Framapad • Die Übersetzungsarbeit wird mit dem kollaborativen Online-Texteditor Framapad verwaltet
• Einzelbeiträge sind durch einen Farbcode gekennzeichnet
• Änderungen erscheinen in Echtzeit auf dem Bildschirm
• Bitte lest die LIES-MICH-Datei, sie enthält zusätzliche Richtlinien.
Verwendet das Glossar Verwendet bei der Übersetzungsarbeit die GLOSSAR-Datei.
Erhaltet den Originaltext Fügt Übersetzungen direkt nach dem Originaltext ein, und behaltet dabei den Originaltext unverändert bei.
Behaltet Code-Abschnitte bei Stellt sicher, dass alle Markdown- und HTML-Formatierungselemente erhalten bleiben.
Respektiert die Arbeit anderer ÜbersetzerInnen • Respektiert bitte die Arbeit anderer Mitwirkender
• Falls Ihr mit einer Übersetzung nicht einverstanden seid, könnt Ihr gerne eigenen Vorschläge einbringen
• Aber bitte ohne bestehende Übersetzungen zu ändern oder zu löschen
Missbraucht Eure Befugnisse nicht Bitte Missbraucht Eure Befugnisse nicht. Übersetzungsarbeit basiert auf Vertrauen.
Wartet auf die Freigabe Übersetzungen werden auf der Webseite veröffentlicht, sobald sie zu 100 % fertiggestellt sind und vom Projektteam geprüft wurden.

Haltet Euch an die Benimmregeln

Anweisungen Beschreibung
Regel #1 Ihr erklärt Euch bereit, mit Menschen aus aller Welt zusammenzuarbeiten, unabhängig von Geschlecht, Alter, Staatsangehörigkeit, ethnischer Zugehörigkeit, Aussehen, Bildung, sozialem Hintergrund oder Religion.
Regel #2 Bitte bleibt in der Diskussion stets freundlich, respektvoll, konstruktiv und beim Thema. Ungehobeltes Verhalten wird nicht toleriert. Keine Flame-Wars; kein Trolling; keine Beleidigungen; keine sexualisierte Sprache; keine öffentliche oder persönliche Belästigung; kein Doxing; keine persönlichen, rassistischen, politischen oder religiösen Angriffe.
Regel #3 Respektiert bitte die Entscheidungen des Projektteams. Wir versuchen, Fragen, Probleme und Zusammenführungsanträge so schnell wie möglich zu lesen, zu prüfen und zu beantworten – aber vergesst nicht, unsere Zeit ist begrenzt. Das Team begrüßt auch Vorschläge, Empfehlungen und Beiträge – was jedoch nicht bedeutet, dass jede Entscheidung im Gruppenkonsens getroffen werden muss.
Regel #4 Bitte vermeidet private Diskussionen über das Projekt, wenn es keinen guten Grund dafür gibt. Solche Diskussionen sollten öffentlich bleiben, und auf GitLab oder über die offiziellen Kommunikationskanäle des Projekts geführt werden.
Regel #5 Reicht mögliche Beschwerden bei gofoss@protonmail.com ein. Verstöße gegen Regel #1 bis #4 können zu angemessenen Maßnahmen führen. Dazu gehören freundliche Ermahnungen, schriftliche Verwarnungen, sowie die Löschung, Bearbeitung oder Zurückweisung von unangemessenen Beiträgen, Kommentaren, Commits, Programmiercodes, Issues oder Zusammenführungsanträgen. Als letztes Mittel kann eine Verbannung aus dem Projekt ausgesprochen werden.

Ihr wollt spenden?

Vielen Dank für Euer Interesse!

Die meisten "kostenlosen" Webseiten verkaufen Werbung, Daten ihrer Nutzer oder kostenpflichtige Inhalte. gofoss.net ist hingegen wirklich frei (wie in Freibier): frei in der Nutzung, frei im Quellcode, frei von Werbung, frei von Tracking, frei von gesponserten oder kostenpflichtigen Inhalten, frei von Affiliate-Links.

gofoss.net ist ein ehrenamtlich geführtes, gemeinnütziges Projekt. Alle Betriebskosten, Entwicklungen und Inhalte werden ausschließlich durch Spenden der NutzerInnen finanziert. Wenn Ihr spenden oder uns einen Kaffee ausgeben möchtet, klickt bitte auf den Knopf unten :)

Mit Liberapay spenden

Erwägt ebenfalls die Unterstützung anderer Open-Source-Entwickler. Oder unterstützt Aktivistengruppen und Software-Stiftungen, die sich für bessere Datenschutzgesetze, Nutzerrechte und Innovationsfreiheit einsetzen:

Zu gofoss.net beitragen


Zurück zum Seitenanfang