TIDAS / TianGong Data System
Questions fréquentes

Guide de contribution à la documentation TIDAS

Bienvenue dans la contribution à la documentation TIDAS ! Voici le processus de contribution :

1. Forkez le projet

  • Visitez la page GitHub TIDAS

  • Cliquez sur le bouton "Fork" dans le coin supérieur droit

  • Sélectionnez votre compte GitHub comme destination

Emplacement du fork

2. Clonez le dépôt

git clone https://github.com/YOUR-USERNAME/tidas.git

Vous pouvez choisir HTTPS ou SSH selon votre configuration. Si vous utilisez SSH, vous devrez ajouter les clés SSH à votre compte GitHub.

Emplacement du clone

3. Apportez des modifications

  • Les fichiers de documentation sont situés dans le répertoire content/docs/

  • Utilisez la syntaxe Markdown pour rédiger la documentation

  • Assurez-vous de suivre le style de documentation existant

4. Validez les modifications

git add .
git commit -m "Describe your changes"
git push origin your-branch-name

5. Créez une Pull Request (PR)

  • Visitez la page de votre dépôt GitHub forké

  • Cliquez sur le bouton "Compare & pull request"

  • Remplissez la description de la PR en expliquant vos modifications

  • Cliquez sur "Create pull request"

6. Révision du code

  • Attendez que les mainteneurs du projet examinent votre PR

  • Apportez les modifications nécessaires en fonction des retours

Directives de contribution

  • Gardez la documentation claire et concise

  • Suivez le formatage et le style existants

  • Assurez-vous que tous les liens sont valides

  • Utilisez la syntaxe Markdown appropriée

Nous recommandons d'utiliser VS Code comme éditeur de code.

Merci pour vos contributions !

Sur cette page