Aller au contenu principal

Guides de développement

Bonnes pratiques et tutoriels pour contribuer au projet THE HIVE.

Guides disponibles

Workflow Git

main ← Production

develop ← Développement

feature/xxx ← Branches de feature
  1. Créer une branche depuis develop
  2. Développer la feature
  3. Créer une Merge Request vers develop
  4. Review + Merge
  5. Deploy sur staging
  6. Merge developmain pour la production

Documenter son code

Backend (Java)

/**
* @doc-category Recrutement
* @doc-feature Gestion des candidatures
* @doc-business Workflow : NEW → TO_MEET → INTERVIEWED → HIRED/REJECTED
* @doc-permission ROLE_RECRUTEUR
*/
@RestController
public class CandidatureController { }

Frontend (TypeScript)

/**
* @doc-category Recrutement
* @doc-feature Hook mise à jour statut
* @doc-usage Utilisé dans JobTable
*/
export function useUpdateApplicationStatus() { }

Ces annotations enrichissent automatiquement la documentation fonctionnelle.