bitshift
1.0.0
bitshift هو محرك بحث دلالي للكود المصدري تم تطويره بواسطة Benjamin Attal وBen Kurtovic وSeveryn Kozak. هذا الملف README مخصص للمطورين فقط. للحصول على نظرة عامة للمستخدم على المشروع:
master : كود يعمل، تم اختباره، مرقم الإصدار - لا يوجد التزامات مباشرة؛ يجب أن يقبل فقط عمليات الدمج من develop عندما يكون جاهزًا للإصدارdevelop : فرع التكامل مع التعليمات البرمجية التي لم يتم إصدارها ولكن معظمها وظيفية - يُسمح بالالتزامات المباشرة ولكن يجب أن تكون بسيطةfeature/* : المكونات الفردية للمشروع مع تعليمات برمجية لم يتم اختبارها ومن المحتمل أن تكون معطوبة بشكل فظيع - تتفرع من وتدمج في develop عند الانتهاء يستخدم bitshift SASS للتصميم؛ قم بتجميع أوراق الأنماط إلى CSS باستخدام sass --watch static/sass/:static/css .
لإنشاء الوثائق، قم بتشغيل make html من الدليل الفرعي docs . يمكنك بعد ذلك التصفح من docs/build/html/index.html .
لتحديث بنية وثائق API تلقائيًا (ضروري عند إضافة وحدات أو حزم جديدة، ولكن ليس عند إضافة وظائف أو تغيير سلاسل المستندات)، قم بتشغيل sphinx-apidoc -fo docs/source/api bitshift من جذر المشروع. لاحظ أن هذا سيؤدي إلى إرجاع أي تغييرات مخصصة تم إجراؤها على الملفات الموجودة في docs/source/api ، لذا قد ترغب في تحديثها يدويًا بدلاً من ذلك.
__version__ في bitshift/__init__.py ، version في setup.py ، version release في docs/conf.py .
