bitshift

pergeseran bit

bitshift adalah mesin pencari semantik untuk kode sumber yang dikembangkan oleh Benjamin Attal, Ben Kurtovic, dan Severyn Kozak. README ini ditujukan untuk pengembang saja. Untuk ikhtisar pengguna proyek:

• baca halaman tentang kami
• tonton video demo kami

Cabang

• master : berfungsi, diuji, kode bernomor versi - tidak ada komitmen langsung; seharusnya hanya menerima penggabungan dari develop ketika siap untuk dirilis
• develop : cabang integrasi dengan kode yang belum dirilis tetapi sebagian besar berfungsi - komitmen langsung diperbolehkan tetapi harus kecil
• feature/* : masing-masing komponen proyek dengan kode yang belum teruji, kemungkinan besar rusak - bercabang dan digabungkan menjadi develop ketika selesai

Gaya

bitshift menggunakan SASS untuk penataan; kompilasi stylesheet ke CSS dengan sass --watch static/sass/:static/css .

Dokumentasi

Untuk membuat dokumentasi, jalankan make html dari subdirektori docs . Anda kemudian dapat menelusuri dari docs/build/html/index.html .

Untuk memperbarui struktur dokumentasi API secara otomatis (diperlukan saat menambahkan modul atau paket baru, namun tidak saat menambahkan fungsi atau mengubah dokumen), jalankan sphinx-apidoc -fo docs/source/api bitshift dari root proyek. Perhatikan bahwa ini akan mengembalikan perubahan khusus apa pun yang dibuat pada file di docs/source/api , jadi Anda mungkin ingin memperbaruinya secara manual.

Melepaskan

• Perbarui __version__ di bitshift/__init__.py , version di setup.py , serta version dan release di docs/conf.py .