Skip to content

Added basic comment to PotionsApiApplication.java just to start the journey #107

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

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

Conversation

harshxrajput
Copy link

@harshxrajput harshxrajput commented Jun 19, 2025

Pull Request Template

Description

Added a basic JavaDoc comment to the PotionsApiApplication class. This comment explains that the class serves as the main entry point for running the Spring Boot application.
This contribution was made as part of Keploy API Fellowship Task 2 to help improve the codebase documentation and readability.

Fixes # ((No issue associated; minor documentation enhancement))

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

This change does not affect runtime behavior or logic, so no specific tests were required.
However, the application still compiles and runs correctly after the comment was added.

Additional Context (Please include any Screenshots/gifs if relevant)

image

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes
  • I have checked my code and corrected any misspellings

Copy link

@pratik-mahalle pratik-mahalle left a comment

Choose a reason for hiding this comment

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

Hey @harshxrajput, Thanks for raising this pr.
Unfortunately, this PR doesn’t include any meaningful changes, typos and breaking links are supposed or just content changes are to be reported not fixed. You can do so on the specific two repositories that we provided. In the future, please ensure that a PR in this repo is raised only if you’ve made substantial updates or solved a particular issue. This helps keep the process efficient and organized.
This being a part of an assignment in api fellowship would be counted since you were supposed to create a pr but wont be merged since this is not that relevant of a change. I’m sure you understand, and I appreciate your cooperation on this. We will be closing this PR for now.

Copy link

@pratik-mahalle pratik-mahalle left a comment

Choose a reason for hiding this comment

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

Hey @,Thanks for raising this pr.
Unfortunately, this PR doesn’t include any meaningful changes. You can do so on the specific two repositories that we provided. In the future, please ensure that a PR in this repo is raised only if you’ve made substantial updates or solved a particular issue. This helps keep the process efficient and organized.
This being a part of an assignment in api fellowship would be counted since you were supposed to create a pr but wont be merged since this is not that relevant of a change. I’m sure you understand, and I appreciate your cooperation on this. We will be closing this PR for now.

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