Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean-up and refactoring for 2.0 #672

Merged
merged 10 commits into from Oct 1, 2022
Merged

Clean-up and refactoring for 2.0 #672

merged 10 commits into from Oct 1, 2022

Conversation

Michael1993
Copy link
Member

@Michael1993 Michael1993 commented Sep 26, 2022

Closes nothing. A very self-indulgent PR/branch.

EDIT: Closes #673. Maybe?

Proposed commit message:

Refactor and document code (#672)

This commit simplifies some code with Java 11, adds some missing
documentation and fixes some code smells as marked by IntelliJ.

PR: #672

PR checklist

The following checklist shall help the PR's author, the reviewers and maintainers to ensure the quality of this project.
It is based on our contributors guidelines, especially the "writing code" section.
It shall help to check for completion of the listed points.
If a point does not apply to the given PR's changes, the corresponding entry can be simply marked as done.

Documentation (general)

  • There is documentation (Javadoc and site documentation; added or updated)
  • There is implementation information to describe why a non-obvious source code / solution got implemented
  • Site documentation has its own .adoc file in the docs folder, e.g. docs/report-entries.adoc
  • Site documentation in .adoc file references demo in src/demo/java instead of containing code blocks as text
  • Only one sentence per line (especially in .adoc files)
  • Javadoc uses formal style, while sites documentation may use informal style

Documentation (new extension)

  • The docs/docs-nav.yml navigation has an entry for the new extension
  • The package-info.java contains information about the new extension

Code

  • Code adheres to code style, naming conventions etc.
  • Successful tests cover all changes
  • There are checks which validate correct / false usage / configuration of a functionality and there are tests to verify those checks
  • Tests use AssertJ or our own PioneerAssert (which are based on AssertJ)

Contributing

  • A prepared commit message exists
  • The list of contributions inside README.md mentions the new contribution (real name optional)

Bukama and others added 5 commits September 23, 2022 00:14
The CartesianTest extension was reimplemented in #487.
At the same time v1 was marked as deprecated and for
removal in Pioneer 2.0.

This PR removes this deprecated version.

Closes: #517
PR: #635
The Locale constructor is deprecated as of Java 19. Therefore, we
replace it by the `Locale.Builder`, which now does syntax checking.

Closes: #658
PR: #662
Starting with release 2.0 Pioneer sets Java 11 as it's base Java version.
With this PR only the build is updated to 11 without any further code
changes to create the new base first.

related #617
PR: #627
@Michael1993 Michael1993 added the full-build Triggers full build suite on PR label Sep 26, 2022
@Michael1993 Michael1993 changed the title A bunch of cleanup/refactor stuff I wanted to get done Clean-up and refactoring for 2.0 Sep 26, 2022
Copy link
Member

@Bukama Bukama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small notes, most personal preferences. Most important ones most probably those about documentation update.

Can't say if changing the ! xx.isPresent() into isEmpty() results in the same output - so I trust the build here :D

@Bukama
Copy link
Member

Bukama commented Sep 30, 2022

Please provide a commit message, so we can merge this

@Bukama Bukama merged commit 8a07082 into lab/2.0 Oct 1, 2022
@Bukama Bukama deleted the lab/refactor branch October 1, 2022 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
full-build Triggers full build suite on PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants