Skip to content

docs: correct database name in spring-mysql-redis readme #110

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

Bipin2004
Copy link

Description

This pull request addresses a documentation error in the spring-mysql-redis/README.md file.

The setup guide for the Docker container incorrectly had a heading for "PostgreSQL" when all the associated commands and the application itself are configured for MySQL. This change corrects the heading to "MySQL" to provide clarity and prevent confusion for developers using this sample.

This fixes a minor documentation bug.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

How Has This Been Tested?

This is a documentation-only change. The fix can be verified with the following steps:

  1. Navigate to the spring-mysql-redis directory.
  2. Open the README.md file.
  3. Confirm that the heading for the database setup now correctly reads #### MySQL Container.

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
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • I have tagged the reviewers in a comment below incase my pull request is ready for a review
  • I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

@Copilot Copilot AI review requested due to automatic review settings June 19, 2025 04:43
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request fixes a documentation error in the spring-mysql-redis sample README by correcting the incorrect PostgreSQL heading to accurately refer to MySQL.

  • Updated heading from "#### PostgreSQL Container" to "#### MySQL Container"
  • Documentation fix to prevent confusion regarding the configured database

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 @Bipin2004, 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.

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