INRIA/spoon

good first issue: add documentation for 3 undocumented public methods

Offen

#1.876 geöffnet am 22.02.2018

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (383 Forks)github user discovery
documentationgood first issue

Repository-Metriken

Stars
 (1.933 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 19T 11h) (49 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Senken Sie den Schwellenwert in der Testdatei, um undokumentierte öffentliche Methoden aufzulisten, und fügen Sie dann jedem Methode Javadoc Kommentare hinzu.
Tech Stack
java
Domain
tooling
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90