Zu JudaicaLink-Projekten beitragen

Vielen Dank für Ihr Interesse an der Mitarbeit an JudaicaLink! Dieser Leitfaden gibt einen Überblick darüber, wie Sie zu verschiedenen Projekten innerhalb des JudaicaLink-Ökosystems beitragen können, einschließlich Docs, Labs, Site, Pubby, Generators und RDF-bezogenen Tools.

Allgemeine Richtlinien für Beiträge

JudaicaLink ist eine Open-Source-Initiative. Beiträge können Folgendes umfassen:

Fehlerberichte und -behebungen
Dokumentation verbessern
Neue Funktionen hinzufügen
RDF-Datensätze und Linked Data verbessern
Leistung optimieren

Alle Beiträge sollten unseren Codierungsstandards und Best Practices folgen.

Einrichten Ihrer Entwicklungsumgebung

1. Repository klonen

Wählen Sie das Projekt aus, zu dem Sie beitragen möchten, und klonen Sie sein Repository:

# Example for Labs
git clone https://github.com/judaicalink/judaicalink-labs.git
cd judaicalink-labs

2. Ein virtuelles Umfeld einrichten

(Für Python-basierte Projekte wie Labs und Pubby)

python -m venv venv
source venv/bin/activate  # On macOS/Linux
venv\Scripts\activate  # On Windows

3. Abhängigkeiten installieren

pip install -r requirements.txt

Für Frontend-Projekte wie die JudaicaLink Site installieren Sie Abhängigkeiten mit Hugo:

brew install hugo  # On macOS
sudo apt install hugo  # On Linux

Für containerisierte Entwicklung mit Docker:

git clone https://github.com/judaicalink/docker.git
cd docker
docker-compose up --build -d

Projektspezifische Beiträge

JudaicaLink Docs

Aktualisieren oder erstellen Sie .rst-Dokumentationsdateien in docs/.
Dokumentation erstellen und anzeigen:

cd docs
make html  # On macOS/Linux
make.bat html  # On Windows

Verbesserungen über einen Pull-Request einreichen.

JudaicaLink Labs

Verbessern Sie die Suchfunktion, Indizierung und Datenintegration.
Arbeiten Sie an Django-basierten Funktionen.
Entwicklungsserver ausführen:

python manage.py runserver

JudaicaLink Seite

Verbessern Sie das UI/UX für die statische Seite.
Ändern Sie config.toml und content/ für neue Seiten.
Seitenänderungen anzeigen:

hugo server

JudaicaLink Pubby

Verbessern Sie SPARQL-Abfragen und Linked Data-Unterstützung.
Verbessern Sie den auf Jena Fuseki basierenden Triple Store.
Pubby testen:

python manage.py runserver

JudaicaLink Generatoren & RDF-Werkzeuge

Verbessern Sie die Daten-Eingabepipelines.
Verbessern Sie RDF-Transformations-Skripte.
Validieren Sie RDF-Ausgaben mit:

rapper -i rdfxml -o turtle data.rdf

Ein Pull-Request einreichen

Forken Sie das Repository auf GitHub.
Erstellen Sie einen neuen Feature-Zweig:

git checkout -b feature-new-update

Machen Sie Änderungen und committen Sie sie:

git add .
git commit -m "Added new feature"

Pushen Sie in Ihren Fork:

git push origin feature-new-update

Öffnen Sie einen Pull-Request auf GitHub und beschreiben Sie Ihre Änderungen.

Probleme melden

Wenn Sie einen Fehler finden, eine Funktionsanfrage haben oder Hilfe benötigen, öffnen Sie ein Problem im entsprechenden GitHub-Repository:

Docs: https://github.com/judaicalink/judaicalink-docs/issues
Labs: https://github.com/judaicalink/judaicalink-labs/issues
Site: https://github.com/judaicalink/judaicalink-site/issues
Pubby: https://github.com/lod-pubby/pubby-django/issues
Generatoren: https://github.com/judaicalink/judaicalink-generators/issues

Verhaltenskodex

Es wird erwartet, dass alle Beitrag leistenden Personen den JudaicaLinkVerhaltenskodex befolgen, um eine respektvolle und kollaborative Umgebung zugewährleisten.

— Vielen Dank für Ihre Mitarbeit an JudaicaLink! 🚀