bitshift

位移位

bitshift 是由 Benjamin Attal、Ben Kurtovic 和 Severyn Kozak 開發的原始碼語意搜尋引擎。本自述文件僅供開發人員使用。有關該項目的使用者概述：

• 閱讀我們的關於頁面
• 觀看我們的演示視頻

分公司

• 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 。