Code does not adhere to conventions (as reported by Checkstyle) #32
Comments
jody
added
documentation
The code within the imagelab, sound folder and Run.java file has been refactored to follow the convention as indicated by the CheckStyle gradle task. This commit fixes the errors causing CheckStyle not reporting any error The most interesting errors were: * Use of magic numbers. https://stackoverflow.com/questions/47882/what-is-a-magic-number-and-wh y-is-it-bad * Hidden field. https://stackoverflow.com/questions/7776046/checkstyle-how-to-resolve-h idden-field-error * Must match pattern https://stackoverflow.com/questions/13146771/java-code-conventions-must -match-pattern-a-za-za-z0-9 * Utility classes should not have a public or default constructor https://stackoverflow.com/questions/14398747/hide-utility-class-constru ctor-utility-classes-should-not-have-a-public-or-def Resolves: MetroCS#32
|
The image depicting the current checkstyle errors is out of date and implies far more errors than exist in the current version. Here is a more up-to-date one that could be utilized instead. Additionally, Team 1A would like to take on this epic. Would you prefer that we open new issues for the specific files that still have deficiencies, or should we handle that at our level and submit a single pull request to close this issue (or at least to correct as much as we can)? |
|
Thank you for updating the current state of this issue. If addressing the remaining errors seems too large, you could treat this as an epic and open individual issues that are more conducive to completion. I am unable to assign an "organization" to an issue, so each individual who wishes to be assigned needs to make a comment directly to this issue. |
|
I would also like to be assigned to this issue. @jody |
|
I would like to be assigned this issue |
|
@jody Can I be assigned this as well to work on with my team? |
|
Since these don't associate with a particular team, can you please confirm that the following are all members of the same team? |
|
Yes, this is correct.
…
On Oct 22, 2020 at 3:41 PM, <Jody Paul ***@***.***)> wrote:
Since these don't associate with a particular team, can you please confirm that the following are all members of the same team?
@robo-jones (https://github.com/robo-jones) @cgamble2 (https://github.com/cgamble2) @DaudAbdi (https://github.com/DaudAbdi) @brianharrity (https://github.com/brianharrity)
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub (#32 (comment)), or unsubscribe (https://github.com/notifications/unsubscribe-auth/ARGYOXCIPESLYTIWQBJX6E3SMCRKFANCNFSM4ML3XBWQ).
|
|
jody
added
S: Significant
jody
modified the milestones:
Fall 2020 Week 13 Release,
Fall 2021 - Collaboration Project 2
ghost
mentioned this issue
Describe the shortcoming
Checkstyle reports errors in java source code files.
To Reproduce
Steps to reproduce the behavior:
./gradlew checkstylebuild/reports/checkstyle/main.htmlExpected behavior
Checkstyle should report no errors with style and coding conventions. Note that ToDo comments are expected to be flagged and do not represent a coding convention violation.
Screenshots
Development environment:
Additional context
This is an epic and should be the umbrella for creating issues to correct the coding style of individual class files.
The text was updated successfully, but these errors were encountered: