Fix Checkstyle #58
Merged
Fix Checkstyle #58
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Checkstyle configurations taken from CS2103T. NOTE: PackageName check is disabled, until I can figure out a REGEX that accomodates the current camelCase package names. Otherwise, a change to the package names to adhere to conventions can be done too.
- Increase length of allowable consecutive capital letters. - Remove requirement to group overloaded methods together.
- Test package rename to align with checkstyle fixes.
4ndrelim
approved these changes
Jan 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Existing checkstyle configuration is too restrictive. Changed to that of CS2103T, which would be more familiar to maintainers and collaborators. Also, modified the configuration to ignore a few conventions.
Package Name. Ideally, package names should be in lowercase, but existing package names are in camelCase. Since there are many existing camelCase-d package names, and it does not cause name-space issues, I removed it.
Misc Conventions. I removed the need to group overloaded methods together.
Notes:
For data classes like Nodes etc, fields should still be private, with public getters/setters.
For class names, must be in PascalCase e.g. DepthFirstSearch and not camelCase depthFirstSearch.