Skip to content

Conversation

devilsrage
Copy link

What does this PR do?
This PR improves the README.md for the Keploy Python Sample Applications repository by:

  • Reorganizing the content for better readability and structure
  • Adding a clear overview table of the sample applications (framework, database, description)
  • Providing clearer contribution guidelines and community support links
  • Highlighting where to submit issues (main Keploy repository)
  • Introducing a Getting Started section to guide users to individual app instructions
  • Ensuring consistent tone and formatting across the README

Why is this needed?

  • The previous README was functional but could benefit from a clearer structure and more engaging tone
  • Makes it easier for newcomers and contributors to understand the repo’s purpose and how to get involved
  • Aligns with Keploy’s documentation quality goals for the API Fellowship program

Checklist

  • IMPROVED README STRUCTURE
  • ADDED APP OVERVIEW TABLE
  • ADDED CONTRIBUTION AND SUPPORT LINKS
  • VERIFIED LINKS ARE CORRECT

Related
Keploy main issue tracker

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 @devilsrage, Thank you for raising the pr. Our team will review it soon

<a href="CODE_OF_CONDUCT.md" alt="Contributions Welcome">
<img src="https://img.shields.io/badge/Contributions-Welcome-brightgreen?logo=github" />
</a>
<a href="https://join.slack.com/t/keploy/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg" alt="Slack Community">

Choose a reason for hiding this comment

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

There was no need to add the code of conduct here

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.

I don't think the changes you have made are relevant

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