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

Add missing documentation and enhance test coverage for getting-started-reactive-crud #1298

Open
wants to merge 1 commit into
base: development
Choose a base branch
from

Conversation

jedla97
Copy link
Contributor

@jedla97 jedla97 commented Jul 13, 2023

Hi, this PR add documentation and additional tests to getting-started-reactive-crud.
As for the documentation whole readme was missing and I wasn't able to find any guide on quarkus.io/ so I wrote some steps for this as I was looking how it's work.
The test only included 2 things (get all and delete). I added coverage for testing add and update fruit as it can be useful for people who are looking how to send these request.

Check list:

Your pull request:

  • targets the development branch
  • uses the 999-SNAPSHOT version of Quarkus
  • has tests (mvn clean test)
  • works in native (mvn clean package -Pnative)
  • has integration/native tests (mvn clean verify -Pnative)
  • makes sure the associated guide must not be updated
  • links the guide update pull request (if needed)
  • updates or creates the README.md file (with build and run instructions)
  • for new quickstart, is located in the directory component-quickstart
  • for new quickstart, is added to the root pom.xml and README.md

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

Thanks. I added a small comment.

Also, probably a good idea for @DavideD to have a look.

@@ -0,0 +1,117 @@
# Getting started with Quarkus

This is a CRUD service exposing endpoints over REST. These endpoints are used for get, add, update
Copy link
Member

Choose a reason for hiding this comment

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

Don't we have a guide for that?

Because we usually avoid duplicating content in the quickstarts. Some of them have a README with a link to the guide.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wasn't able to find it so I write at least what it's does. Now after some digging I found out that the guide was there in past but was changed by this PR . It seems that PR replace this quickstart by hibernate-reactive-panache-quickstart.

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.

2 participants