Skip to content

docs: added beginner tip for keploy gen verbose flag #541

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 5 commits into
base: main
Choose a base branch
from

Conversation

Dur-jaya
Copy link

docs: Add beginner tip for keploy gen --verbose flag

📝 Summary

Added a tip in the README to recommend using the --verbose flag with keploy gen for better debugging and step-by-step visibility.

📚 Motivation

As a beginner, I found that seeing verbose logs really helped me understand what Keploy was doing under the hood. I believe this tip can help others too.

🔗 Fellowship Task

This PR is a part of the Keploy API Fellowship program – Task 2 (Open Source Contribution).


Let me know if you want me to improve or adjust the formatting!

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you and congratulations 🎉 for opening your very first pull request in keploy

Copy link
Member

@nehagup nehagup left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. Good tip!

Please add this to docs website. :)

@Dur-jaya
Copy link
Author

Thanks for the PR. Good tip!

Please add this to docs website. :)

Thanks @nehagup! 😊
I've added the beginner tip to the docs website as requested. Let me know if anything else is needed!

Signed-off-by: Durjaya Das <[email protected]>
@CBID2
Copy link

CBID2 commented Jun 18, 2025

Thanks for the PR. Good tip!
Please add this to docs website. :)

Thanks @nehagup! 😊 I've added the beginner tip to the docs website as requested. Let me know if anything else is needed!

Hi @Dur-jaya! :) I just noticed that one of the tests in your pull request has failed.This explains the error.

@Dur-jaya Dur-jaya closed this Jun 18, 2025
@Dur-jaya Dur-jaya reopened this Jun 18, 2025
@Dur-jaya Dur-jaya force-pushed the durjaya-beginner-tip branch from d7de16f to f731423 Compare June 18, 2025 19:57
@Dur-jaya
Copy link
Author

Dur-jaya commented Jun 18, 2025

@keploy-bot can you please recheck the DCO status? I have force-pushed signed commits.

@@ -180,6 +176,12 @@ When we merge your PR, a new build automatically occurs and your changes publish
## How to Get Involved?

Keploy welcomes contributions to the docs website. If you have an idea for a new feature or a bug fix, please submit an issue or pull request. Our planned features can be found on our [Issue Tracker](https://github.com/keploy/keploy/issues/new/choose).
### keploy gen
Copy link
Member

Choose a reason for hiding this comment

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

Can you please mention the reason for mentioning this info here? keploy gen is for generating tests.

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.

3 participants