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

Improve README and Example class #32

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

NewtonMan
Copy link

Description

Improvement on Example class and README with more instructions to Maven users

Details

There are some errors in the Example class and was not totally clear that we need to install this before add dependency to project POM

Testing

Just executing the Example class

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
    • If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
  • Any Public API changes are explained in the PR details and conform to existing APIs

Testing

  • I have personally tested this on my device, or explained why that is not possible

Final pass

  • Code is as readable as possible.
    • Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
  • I have reviewed this PR myself, ensuring it meets each checklist item
    • WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

Adjustments on the Example class
Add first the example to clone repo
Better clarify instructions to Maven users
@NewtonMan NewtonMan closed this Jul 22, 2024
@NewtonMan NewtonMan reopened this Jul 22, 2024
@NewtonMan
Copy link
Author

Please, anyone can review this?
@gdeglin @leemunroe @jmadler @jkasten2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant