RepoSense icon indicating copy to clipboard operation
RepoSense copied to clipboard

Add descriptions to Gradle tasks

Open yhtMinceraft1010X opened this issue 1 year ago • 1 comments

What feature(s) would you like to see in RepoSense

This was initially mentioned in a PR review for #1925

Having descriptions for some custom Gradle tasks can help understand why certain tasks exist. For example, the task 'zipReport': https://github.com/reposense/RepoSense/blob/962c97ec3bcfb0ec4af6b5bdf080cae27d3af671/build.gradle#L70-L75

Developers may not know why zipReport is needed.

If possible, describe the solution

Gradle has a description property that can be set for each task

Additional Context

This has been set as a FirstTimer issue. Do try to understand what each Gradle task is doing before attempting this.

yhtMinceraft1010X avatar Mar 18 '23 10:03 yhtMinceraft1010X

Do you think it is suitable to put this as a first time issue since the task seems simple and can help new contributors get familiar with the CI workflow

HCY123902 avatar Mar 18 '23 11:03 HCY123902