INRIA/spoon

good first issue: add documentation for 3 undocumented public methods

Aperta

#1876 aperta il 22 feb 2018

Vedi su GitHubGuida contributor
 (8 commenti) (0 reazioni) (0 assegnatari)Java (383 fork)github user discovery
documentationgood first issue

Metriche repository

Star
 (1933 stelle)
Metriche merge PR
 (Merge medio 19g 11h) (49 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Abbassa la soglia nel file di test per elencare i metodi pubblici non documentati, quindi aggiungi commenti Javadoc a ciascun metodo.
Tech stack
java
Dominio
tooling
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90