Aller au contenu principal

đŸ€ Collaboration

Vous souhaitez contribuer à docsDirecte ? C'est grùce à la communauté que cette documentation reste à jour et complÚte !

Pourquoi collaborer ?​

L'API d'EcoleDirecte change souvent, et nous ne pouvons pas tout voir seuls. En apportant votre aide, vous aidez des centaines d'autres développeurs et vous serez ajouté à la page des Crédits.

Comment aider ?​

Voici les étapes recommandées :

1. 🔍 Recherches​

Explorez l'API par vous-mĂȘme en utilisant les outils de dĂ©veloppement de votre navigateur sur EcoleDirecte. Notez les points de terminaison (endpoints), les paramĂštres envoyĂ©s et la structure des rĂ©ponses. Nous utilisons Firefox DevTools et HTTP Toolkit pour cela.

2. 📝 Formulation des recherches​

Structurez vos découvertes de maniÚre claire :

  • Quel est l'URL de l'endpoint ?
  • Quelle est la mĂ©thode HTTP (GET, POST, etc.) ?
  • Quel est le format de la requĂȘte et de la rĂ©ponse ?
  • Quelles sont les conditions nĂ©cessaires (ex: type de compte, token) ?

3. 🚀 Passer à l'action​

Une fois vos recherches prĂȘtes, vous avez deux options :

  • CrĂ©er une Issue sur GitHub : Si vous avez trouvĂ© une erreur ou une nouvelle info mais ne savez pas comment modifier la doc.
  • CrĂ©er une Pull Request : Si vous ĂȘtes prĂȘt Ă  modifier le code ou le texte directement.

Autres moyens de nous contacter​

Si vous ne souhaitez pas utiliser GitHub, vous pouvez nous envoyer vos dĂ©couvertes par email : 📧 evo@directe.qzz.io

Merci pour votre aide !