bitshift

Bitverschiebung

Bitshift ist eine semantische Suchmaschine für Quellcode, die von Benjamin Attal, Ben Kurtovic und Severyn Kozak entwickelt wurde. Diese README-Datei ist nur für Entwickler gedacht. Für eine Benutzerübersicht des Projekts:

• Lesen Sie unsere About-Seite
• Sehen Sie sich unser Demo-Video an

Zweige

• master : funktionierender, getesteter Code mit Versionsnummer – keine direkten Commits; sollte Zusammenführungen aus develop nur akzeptieren, wenn sie zur Veröffentlichung bereit sind
• develop : Integrationszweig mit unveröffentlichtem, aber größtenteils funktionsfähigem Code – direkte Commits sind zulässig, sollten jedoch geringfügig sein
• feature/* : einzelne Komponenten des Projekts mit ungetestetem, wahrscheinlich schrecklich kaputtem Code – verzweigen Sie von und führen Sie sie nach Abschluss in develop zusammen

Stil

Bitshift verwendet SASS für das Styling; Kompilieren Sie die Stylesheets mit sass --watch static/sass/:static/css in CSS.

Dokumentation

Um die Dokumentation zu erstellen, führen Sie make html im Unterverzeichnis docs aus. Sie können dann von docs/build/html/index.html aus navigieren.

Um die API-Dokumentationsstruktur automatisch zu aktualisieren (notwendig beim Hinzufügen neuer Module oder Pakete, aber nicht beim Hinzufügen von Funktionen oder Ändern von Dokumentzeichenfolgen), führen Sie sphinx-apidoc -fo docs/source/api bitshift im Projektstammverzeichnis aus. Beachten Sie, dass dadurch alle benutzerdefinierten Änderungen, die an den Dateien in docs/source/api vorgenommen wurden, rückgängig gemacht werden. Daher sollten Sie sie stattdessen möglicherweise manuell aktualisieren.

Loslassen

• Aktualisieren Sie __version__ in bitshift/__init__.py , version in setup.py und version und release in docs/conf.py .