INRIA/spoon

good first issue: add documentation for 3 undocumented public methods

開放

#1,876 建立於 2018年2月22日

 (8 則留言) (0 個反應) (0 位負責人)Java (383 個分叉)github user discovery
documentationgood first issue

倉庫指標

星標
 (1,933 顆星)
PR 合併指標
 (平均合併 19天 11小時) (30 天內合併 49 個 PR)

描述

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

貢獻者指南