RoboLoCo-5338/Competition_Bot_2025

Further Style Guidelines

Open

#161 opened on May 19, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (0 forks)auto 404
documentationenhancementgood first issuepriority: lowrequires bot: none

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

Discussed in https://github.com/orgs/RoboLoCo-5338/discussions/149

Originally posted by Advay17 May 5, 2025 One annoying thing about our code (that I am partially a contributor to) is that even though our general style is somewhat unified through spotless, the specific code itself does have discrepancies that I would like to rectify. For instance, our constants don't follow one naming format or another. Another issue is our branch naming, for which we don't have a consistent pattern.

We need to create stricter guidelines on formatting. I suggest that we use checkstyle to enforce this, and will look into installing it onto our repo soon.

See the source discussion for the list of checks I want added.

Contributor guide

Research direction
Investigate existing code style inconsistencies, research checkstyle configuration for Java, and propose a set of rules to standardize constants naming and branch naming.
Tech stack
java
Domain
developer experience
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75