Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Removed Irrelevant Languages from Test Coverage Generation Section #420

Merged
merged 6 commits into from
Jul 31, 2024
Merged

Removed Irrelevant Languages from Test Coverage Generation Section #420

merged 6 commits into from
Jul 31, 2024

Conversation

starvader13
Copy link
Contributor

Pull Request Template

Description

Refactored the documentation to remove irrelevant language-specific instructions from the test coverage generation section.

###Refactored Documentation:

  1. Removed Java-related instructions from the other code sections.
  2. Ensured other sections do not include a Go-specific Graceful Shutdown.
  3. Removed any unrelated code snippets or instructions from the sections specific to each programming language.
  4. Make sure that the different cleanup function is only included in the corresponding languages.

Fixes keploy/keploy#2070

Type of change.

  • This change requires a documentation update.

@starvader13
Copy link
Contributor Author

@shivamsouravjha Review Required!!

@nehagup nehagup requested a review from shivamsouravjha July 18, 2024 09:44
@shivamsouravjha
Copy link
Contributor

also make sure the note of jvm not be present in go and js similary go code not be present in java or go.

@starvader13
Copy link
Contributor Author

starvader13 commented Jul 18, 2024 •
edited
Loading

Also make sure the note of jvm not be present in go and js similary go code not be present in java or go.

Same for this one. There is no interference of any language but for a better description let me share you with the structure.

Go

  • Prerequisites: Specific to Go.
  • Usage Instructions: Contains Go commands and scripts.
  • Code Examples: Written in Go.
  • Conclusion: Exclusively Go-related content.

Java

  • Prerequisites: Specific to Java.
  • Usage Instructions: Involves Maven and Java-specific commands.
  • Code Examples: XML configuration for Maven.
  • Conclusion: Exclusively Java-related content.

JavaScript

  • Prerequisites: Specific to JavaScript.
  • Usage Instructions: Uses npm and JavaScript-specific commands.
  • Code Examples: JSON for package.json.
  • Conclusion: Exclusively JavaScript-related content.

Python

  • Prerequisites: Specific to Python.
  • Usage Instructions: Uses Python commands and scripts.
  • Code Examples: Written in Python.
  • Conclusion: Exclusively Python-related content.

@starvader13 starvader13 force-pushed the issue_2070 branch 2 times, most recently from 06f3f20 to 4b6f636 Compare July 22, 2024 09:18
@shivamsouravjha
Copy link
Contributor

the changes look good can you resolve the conflicts and the build failures?

@starvader13
Copy link
Contributor Author

The changes look good can you resolve the conflicts and the build failures?

Roger that

@starvader13 starvader13 force-pushed the issue_2070 branch 5 times, most recently from 8edbd5b to a24e4d5 Compare July 26, 2024 01:29
@starvader13
fix: refactor test coverage generation section for Go
07d628b 
Add graceful shutdown function
Update Language Requirements
Remove java specific code

Signed-off-by: starvader13 <[email protected]>
@starvader13
fix: refactor test coverage generation section for Java
0c713b6 
Update Language Requirements
Add jvm section

Signed-off-by: starvader13 <[email protected]>
@starvader13
fix: refactor test coverage generation section for Javascript
e6c8779 
Update Language Requirements
Remove jvm and graceful shutdown

Signed-off-by: starvader13 <[email protected]>
@starvader13
fix: refactor test coverage generation section for Python
061f91e 
Update Language Requirements
Remove jvm and graceful shutdown

Signed-off-by: starvader13 <[email protected]>
@starvader13
Copy link
Contributor Author

@shivamsouravjha I don't know why Prettier is failing. Can you look into that?

shivamsouravjha
shivamsouravjha approved these changes Jul 31, 2024
View reviewed changes
Copy link
Contributor

@shivamsouravjha shivamsouravjha left a comment

Choose a reason for hiding this comment

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

LGTM!

@shivamsouravjha shivamsouravjha merged commit aa20927 into keploy:main Jul 31, 2024
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shivamsouravjha shivamsouravjha shivamsouravjha approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs]: code for irrelevant languages be removed from test coverage generation section
2 participants
@starvader13 @shivamsouravjha