TarekSaeed0/chess

doc: add documentation to chess.h

Ouverte

#2 ouverte le 26 mai 2025

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)C (0 fork)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (0 étoile)
Métriques de merge PR
 (Métriques PR en attente)

Description

adding Doxygen comments for the various types and functions in chess.h will help with new contributors and users of the library, understand the various types and functions defined and how to use them correctly, as currently the generated documentation is mostly empty.

Guide contributeur

Direction de recherche
Ouvrez chess.h et ajoutez des commentaires Doxygen pour chaque type et fonction en suivant les conventions existantes. Utilisez les balises `@param`, `@return`, `@brief`.
Stack technique
c
Domaine
backend
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.
1
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.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90