bitshift

cambio de bits

bitshift es un motor de búsqueda semántica de código fuente desarrollado por Benjamin Attal, Ben Kurtovic y Severyn Kozak. Este archivo README está destinado únicamente a desarrolladores. Para obtener una descripción general del proyecto para el usuario:

• lee nuestra página acerca de
• mira nuestro vídeo de demostración

Sucursales

• master : código funcional, probado y con número de versión; sin confirmaciones directas; solo debe aceptar fusiones de develop cuando esté listo para publicarse
• develop : rama de integración con código inédito pero mayoritariamente funcional: se permiten confirmaciones directas, pero deben ser menores
• feature/* : componentes individuales del proyecto con código no probado y probablemente terriblemente roto: se bifurca y se fusiona con develop cuando haya terminado

Estilo

bitshift usa SASS para diseñar; Compile las hojas de estilo en CSS con sass --watch static/sass/:static/css .

Documentación

Para crear documentación, ejecute make html desde el subdirectorio docs . Luego puede navegar desde docs/build/html/index.html .

Para actualizar automáticamente la estructura de la documentación de la API (necesaria al agregar nuevos módulos o paquetes, pero no al agregar funciones o cambiar cadenas de documentos), ejecute sphinx-apidoc -fo docs/source/api bitshift desde la raíz del proyecto. Tenga en cuenta que esto revertirá cualquier cambio personalizado realizado en los archivos en docs/source/api , por lo que es posible que desee actualizarlos manualmente.

Liberando

• Actualice __version__ en bitshift/__init__.py , version en setup.py y version y release en docs/conf.py .