Use CI action to lint and format the code
- Dominant language
- Java
- Stars
- 80
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
# Use CI action to lint and format the code
## Context
To keep the things homogeneous and clear in the code base, the project contains a folder with format rules for both Eclipse and Intellij (in `ide-resources`).
This has several drawbacks :
* We're not supporting all environments (like Netbeans, VSCode, Sublime, Atom...)
* We rely on each dev to install the format style on their IDE, which (dependant of how the installation was made), can erase their own settings
* We host xml datas which have no value for the project.
## Expected
We can add a step in the CI pipeline which will apply the correct format to each PR or branch. By doing so, we're sure that the codebase will have only one format, and we will not have to check the format, import orders, or anything like this in all the PR.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by inspecting the existing CI configuration and the format-rule files under ide-resources. Determine how the Java code, formatting, and import order are currently checked, then define a CI step that applies or verifies the project format for pull requests; done means formatting is consistently enforced without relying on IDE-specific setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100