INRIA/spoon

good first issue: add documentation for 3 undocumented public methods

Ouverte

#1 876 ouverte le 22 févr. 2018

Voir sur GitHubGuide contributeur
 (8 commentaires) (0 réaction) (0 personne assignée)Java (383 forks)github user discovery
documentationgood first issue

Métriques du dépôt

Stars
 (1 933 étoiles)
Métriques de merge PR
 (Merge moyen 19j 11h) (49 PRs mergées en 30 j)

Description

In Spoon, we want that all public methods are properly documented.

We have a test case to check this: https://github.com/INRIA/spoon/blob/51c4b2211922e71914f74ce4341a6232c079f174/src/test/java/spoon/test/architecture/SpoonArchitectureEnforcerTest.java#L120

This test case temporarily skips small methods.

To get this issue done:

  • List the undocumented public methods:
    • lower the threshold size() > 33 in the test case
    • run the test case, this will list you undocumented public methods
  • Add appropriate Javadoc documentation /** .... */
  • Create a pull request with your changes

Guide contributeur

Direction de recherche
Abaissez le seuil dans le fichier de test pour lister les méthodes publiques non documentées, puis ajoutez des commentaires Javadoc à chaque méthode.
Stack technique
java
Domaine
tooling
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.
Moins d'une heure
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
JavaGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90