Ce référentiel contient le code source de la documentation du créateur sur create.roblox.com/docs.
Remarque : Actuellement, le référentiel contient des guides, des didacticiels, du contenu éducatif et la référence de l'API Engine. Des exemples de code seront bientôt disponibles.
Si vous n'êtes pas familier avec le processus de contribution GitHub, consultez À propos des demandes d'extraction et la vidéo suivante.
Si vous rencontrez un problème avec la documentation et que vous ne souhaitez pas soumettre de pull request, veuillez nous le faire savoir en le signalant sur les forums des développeurs Roblox.
Tout ajout à la documentation du créateur Roblox doit s'inscrire dans un ensemble plus vaste. En d’autres termes, même un article de blog ou un livre blanc technique complet, précis et bien rédigé peut ne pas avoir sa place sur le site Web.
De manière générale, nous recherchons un contenu conforme à nos normes existantes et s’appliquant à une grande variété d’expériences et de cas d’utilisation. Par exemple, nous préférons les pages telles que Création d'interfaces utilisateur à des pages telles que Création d'un compteur de vitesse pour un jeu de course . Pensez à publier des guides plus spécialisés sur le forum des développeurs Roblox.
Lorsque vous soumettez une pull request pour examen, vous devez accepter ce qui suit :
Cette contribution a été créée en tout ou en partie par moi, et j'ai le droit de la soumettre selon les termes des licences open source de ce référentiel.
Je comprends et j'accepte que cette contribution et un enregistrement de celle-ci soient publics, conservés indéfiniment et peuvent être redistribués selon les termes des licences open source de ce référentiel.
Au meilleur de ma connaissance, toutes les modifications proposées sont exactes.
Pour des modifications simples qui ne concernent qu'un seul fichier, utilisez l'éditeur Web de GitHub :
Recherchez le fichier dans content/en-us/ et cliquez sur Modifier ce fichier .
Cliquez sur Fork ce référentiel .
Apportez vos modifications et cliquez sur Valider les modifications... .
Donnez à votre modification un message de validation descriptif et cliquez sur Proposer des modifications .
Assurez-vous que le référentiel de base est Roblox/creator-docs et que la branche de base est main . Vérifiez que vous êtes satisfait de vos modifications et cliquez sur Créer une demande d'extraction .
Enfin, remplissez les détails dans la description de la pull request et cliquez sur Create pull request .
Pour des modifications plus importantes touchant plusieurs fichiers, nous recommandons github.dev, un éditeur de texte plus complet basé sur Visual Studio Code qui s'exécute dans votre navigateur :
Forkez le référentiel.
Tout en parcourant votre fork, appuyez sur le bouton . clé pour ouvrir github.dev.
Dans le menu Contrôle de code source , cliquez sur ... > Branche > Créer une branche... .
Donnez un nom à la branche et cliquez sur Passer à la branche .
Utilisez le menu Explorateur pour rechercher les fichiers que vous souhaitez mettre à jour dans content/en-us et apportez les modifications souhaitées.
Dans le menu Contrôle de source , vérifiez que vous êtes satisfait de vos modifications.
Ajoutez un message de validation et cliquez sur Commit & Push .
Dans un nouvel onglet de navigateur, accédez à github.com/Roblox/creator-docs.
Cliquez sur Comparer et tirer la demande .
Vérifiez que le référentiel de base est Roblox/creator-docs et que la branche de base est main . Le référentiel principal doit être votre fork et votre branche.
Enfin, remplissez les détails dans la description de la pull request et cliquez sur Create pull request .
Vous pouvez également utiliser les menus GitHub ou GitHub Pull Request dans github.dev pour soumettre la pull request. Pour obtenir de la documentation sur l'utilisation de github.dev, consultez GitHub Codespaces.
Ce référentiel est extrêmement volumineux, nous vous recommandons donc d'utiliser les options en ligne autant que possible. Cependant, si vous êtes déjà familier avec le workflow général de GitHub et que vous souhaitez utiliser un éditeur de texte hors ligne, voici les étapes de base pour contribuer à la documentation :
Configurez Git et Git LFS. Vous pouvez également installer un client Git comme GitHub Desktop.
Forkez ce référentiel.
Clonez votre fourchette.
Accédez à la racine du référentiel.
Créez une nouvelle branche.
Apportez les modifications souhaitées.
Validez, poussez vers votre fork et soumettez votre demande d'extraction sur la branche main de ce référentiel.
Pour des étapes plus détaillées, voir CONTRIBUTING.md.
La documentation Roblox comporte trois types de documents principaux :
Guides conceptuels et basés sur les tâches dans les fichiers .md dans content/en-us/
Les guides vous apprennent une fonctionnalité ou un flux de travail sans être trop prescriptifs quant au résultat final. Ils présentent des concepts et des fonctionnalités et couvrent les tâches que vous pouvez accomplir à l'aide de divers outils ou d'autres approches.
Les guides bénéficient massivement de cas d’utilisation pratiques et réels, d’images, d’extraits de code et de diagrammes. La plupart des contenus basés sur des tâches doivent inclure une liste numérotée.
Documents de référence sur l'API dans les fichiers .yaml dans content/en-us/reference
Les API sont entièrement du contenu de référence et doivent utiliser des descriptions fonctionnelles, avec des liens vers des guides le cas échéant. Plus que les autres types de contenu, le contenu de référence doit être concis et direct ; les résumés des propriétés, des méthodes, des événements et des rappels n'ont pas besoin d'être des phrases complètes.
Tutoriels dans les fichiers .md dans content/en-us/tutorials
Comparés aux guides basés sur des tâches, les didacticiels sont plus autonomes et vous font passer de rien à quelque chose . Cette concentration sur la création de quelque chose de spécifique signifie qu'ils sont généralement beaucoup plus prescriptifs que les guides. Les didacticiels abordent souvent plusieurs fonctionnalités et concepts en même temps, démontrant les liens entre les outils et les stratégies.
Si votre contribution ne rentre pas dans ces catégories ou couvre un sujet particulièrement restreint, elle pourrait ne pas convenir à la documentation. Pensez à le publier sur le forum des développeurs Roblox.
Essayez de limiter vos modifications à une classe ou une fonctionnalité afin que la demande d'extraction soit plus facile à examiner. Les corrections de bugs et les petites améliorations ont plus de chances d’être approuvées rapidement. Les grands guides nécessitent souvent d’importants allers-retours avant leur publication.
Pour éviter les problèmes de formatage, nous recommandons les éditeurs de texte comme github.dev qui vous permettent de prévisualiser Markdown au fur et à mesure que vous l'écrivez. Pour la prose, essayez de suivre les directives de STYLE.md. Pour des exemples de code, utilisez le Lua Style Guide.
Pour afficher une page entièrement formatée selon ce que nous voyons sur la branche main , remplacez l'URL entière de content/ et avant. Les fichiers avec l' index de nom de base doivent voir ce nom supprimé. Par exemple, la page « https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md » est rendue sur « https://create.roblox.com /docs/en-us/avatar".
Pour la prose, ce projet utilise la licence publique internationale Creative Commons Attribution 4.0. Pour le texte complet de la licence, voir LICENCE.
Des exemples de code sont disponibles sous la licence MIT. Pour le texte complet de la licence, voir LICENSE-CODE.
Pour maintenir une communauté ouverte, accueillante, diversifiée, inclusive et saine, ce projet applique une version adaptée du Contributor Covenant. Pour plus d’informations, consultez CODE_OF_CONDUCT.md.
