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 문서 구조를 자동으로 업데이트하려면(새 모듈이나 패키지를 추가할 때 필요하지만 함수를 추가하거나 Docstring을 변경할 때는 필요하지 않음 ) 프로젝트 루트에서 sphinx-apidoc -fo docs/source/api bitshift 실행하세요. 이렇게 하면 docs/source/api 파일에 대한 사용자 정의 변경 사항이 모두 되돌려지므로 대신 수동으로 업데이트하는 것이 좋습니다.

출시

• bitshift/__init__.py 의 __version__ , setup.py 의 version , docs/conf.py 의 version 및 release 업데이트합니다.