bitshift

ビットシフト

bitshift は、Benjamin Attal、Ben Kurtovic、Severyn Kozak によって開発されたソース コードのセマンティック検索エンジンです。この README は開発者のみを対象としています。プロジェクトのユーザー概要については、次を参照してください。

• 私たちの概要ページを読んでください
• デモビデオをご覧ください

支店

• master : 動作し、テストされ、バージョン番号が付けられたコード - 直接コミットはありません。リリースの準備ができた場合にのみdevelopからのマージを受け入れる必要があります
• develop : 未リリースだがほとんど機能するコードを含む統合ブランチ - 直接コミットは許可されますが、マイナーである必要があります
• feature/* : テストされておらず、ひどく壊れている可能性が高いコードを含むプロジェクトの個々のコンポーネント - 完了したら、 developから分岐してマージします。

スタイル

bitshift はスタイル設定に SASS を使用します。 sass --watch static/sass/:static/cssを使用してスタイルシートを CSS にコンパイルします。

ドキュメント

ドキュメントを構築するには、 docsサブディレクトリからmake htmlを実行します。その後、 docs/build/html/index.htmlから参照できます。

API ドキュメント構造を自動的に更新するには (新しいモジュールまたはパッケージを追加する場合は必要ですが、関数を追加したりドキュメント文字列を変更する場合は必要ありません)、プロジェクト ルートからsphinx-apidoc -fo docs/source/api bitshift実行します。これにより、 docs/source/api内のファイルに加えられたカスタム変更がすべて元に戻されるため、代わりに手動で更新することをお勧めします。

解放する

• bitshift/__init__.pyの__version__ 、 setup.pyのversion 、 docs/conf.pyのversionとreleaseを更新します。