Skip to main content

Cette version de GitHub Enterprise Server n'est plus disponible depuis le 2024-03-26. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

Utilisation de l’espace réservé TODOCS pour laisser des notes

Vous pouvez utiliser l’espace réservé TODOCS pour indiquer un travail qui doit encore être effectué.

Utilisation de l’espace réservé TODOCS

Parfois, les rédacteurs techniques utilisent des espaces réservés lors de l’écriture de la documentation pour se rappeler de revenir à quelque chose plus tard. C’est une technique pratique, mais il y a toujours la possibilité que l’espace réservé soit oublié et passe tel quel en production. À ce stade, la seule façon pour l’équipe Docs de le savoir est quand quelqu’un le voit et le signale.

Pour éviter ces dérapages, utilisez la chaîne TODOCS comme espace réservé. La suite de tests Docs inclut un test de linting qui échoue s’il trouve cette chaîne n’importe où dans un fichier Markdown ou YAML.

Remarque : Si vous utilisez VS Code comme éditeur de texte, l’extension « TODO Highlight » est utile pour mettre en surbrillance les instances de « TODOCS » dans vos fichiers. Ajoutez « TODOCS » et d’autres variations de la casse, comme « todocs », aux paramètres de cette extension.

Exemple

1. In the dropdown, select the settings you want to sync.

   TODOCS: ADD A SCREENSHOT OF THE SETTINGS SYNC OPTIONS

1. Click **Sign in & Turn on**, then select the account to which you want your settings to be synced.