INRIA/spoon

good first issue: add documentation for 3 undocumented public methods

Open

#1,876 opened on Feb 22, 2018

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)Java (383 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (1,933 stars)
PR merge metrics
 (Avg merge 19d 11h) (49 merged PRs in 30d)

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

Contributor guide

Research direction
Lower the threshold in the test file to list undocumented public methods, then add Javadoc comments to each method.
Tech stack
java
Domain
tooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90