Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Address code style issues in the existing code base #49

Open
CrsiX opened this issue Jun 5, 2021 · 0 comments
Open

Address code style issues in the existing code base #49

CrsiX opened this issue Jun 5, 2021 · 0 comments
Labels
good first issue Good for newcomers

Comments

@CrsiX
Copy link
Collaborator

CrsiX commented Jun 5, 2021

Issue #38 has added a CI pipeline to check for Java style guide violations. However, the existing problems (look here) are not addressed yet. This issue aims to be a reference for everyone who wants to introduce fixes to the existing code base. Most of the problems may be fixed easily using an automatic linter, others may need manual edits.

I would also like to add a status badge on the README like the example below:

Java Style Checker

But actually, even though we have lots of style violations the badge says 'passing' (at least currently). As that's not accurate yet, I won't add it yet.

Code snippet for this particular badge:

[![Java Style Checker](https://github.com/N0W0RK/TUM_GAD_Tests_SS21/actions/workflows/checkstyle.yml/badge.svg)](https://github.com/N0W0RK/TUM_GAD_Tests_SS21/actions/workflows/checkstyle.yml)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant