bitshift

décalage de bits

bitshift est un moteur de recherche sémantique de code source développé par Benjamin Attal, Ben Kurtovic et Severyn Kozak. Ce README est destiné uniquement aux développeurs. Pour un aperçu utilisateur du projet :

• lisez notre page à propos
• regardez notre vidéo de démonstration

Succursales

• master : code fonctionnel, testé, numéroté de version - pas de validation directe ; ne devrait accepter les fusions du develop que lorsqu'il est prêt à être publié
• develop : branche d'intégration avec du code inédit mais principalement fonctionnel - les commits directs sont autorisés mais devraient être mineurs
• feature/* : composants individuels du projet avec du code non testé, probablement horriblement cassé - bifurquez et fusionnez dans develop une fois terminé

Style

bitshift utilise SASS pour le style ; compilez les feuilles de style en CSS avec sass --watch static/sass/:static/css .

Documentation

Pour créer de la documentation, exécutez make html à partir du sous-répertoire docs . Vous pouvez ensuite parcourir depuis docs/build/html/index.html .

Pour mettre à jour automatiquement la structure de la documentation de l'API (nécessaire lors de l'ajout de nouveaux modules ou packages, mais pas lors de l'ajout de fonctions ou de la modification de docstrings), exécutez sphinx-apidoc -fo docs/source/api bitshift à partir de la racine du projet. Notez que cela annulera toutes les modifications personnalisées apportées aux fichiers dans docs/source/api , vous souhaiterez donc peut-être les mettre à jour manuellement.

Libération

• Mettez à jour __version__ dans bitshift/__init__.py , version dans setup.py , ainsi que version et release dans docs/conf.py .