Skip to content

refactor: add comments for clarity in DeliveryService, SampleDataServ… - #18

Open
JakeConal wants to merge 1 commit into
mainfrom
chore/add-comments-for-clarity
Open

JakeConal wants to merge 1 commit into
mainfrom
chore/add-comments-for-clarity

Conversation

@JakeConal

Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings May 2, 2026 02:27
@sonarqubecloud

sonarqubecloud Bot commented May 2, 2026

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR adds inline comments to a few service methods/classes to clarify intent and behavior across the webhook, sampledata, and delivery modules.

Changes:

  • Document event ordering/mapping behavior in EventService#findAllEvents.
  • Explain why sample data seeding logic is centralized in SampleDataService#createSampleData.
  • Add a brief note explaining why DeliveryService is intentionally minimal.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
webhook/src/main/java/com/yas/webhook/service/EventService.java Adds a short comment describing the sort order and mapping to view models.
sampledata/src/main/java/com/yas/sampledata/service/SampleDataService.java Adds a comment explaining the rationale for keeping seeding in one place.
delivery/src/main/java/com/yas/delivery/service/DeliveryService.java Adds a comment explaining why the service is minimal (but currently introduces a tab).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


@Service
public class DeliveryService {
// Intentionally left minimal for Spring wiring and CI coverage.
@sonarqubecloud

sonarqubecloud Bot commented May 2, 2026

Copy link
Copy Markdown

This branch has not been deployed

No deployments
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.

4 participants