OpenXRay/xray-16

Documentation

Ouverte

#207 ouverte le 25 mai 2018

Voir sur GitHubGuide contributeur
 (4 commentaires) (3 réactions) (0 personne assignée)C++ (519 forks)auto 404
Code QualityDocumentationHelp wantedInfrastructure

Métriques du dépôt

Stars
 (3 524 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

We should document all the engine's code.

I suggest to use Doxygen, which is widely used. Other alternatives, maybe?

Guide contributeur

Direction de recherche
Recherchez la configuration Doxygen pour les projets C++ et proposez une configuration de génération de documentation pour la base de code du moteur.
Stack technique
cpp
Domaine
game devdocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80