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

Add a small documentation for ApprovalTests #9658

Closed
murdos opened this issue Apr 26, 2024 · 3 comments · Fixed by #10774
Closed

Add a small documentation for ApprovalTests #9658

murdos opened this issue Apr 26, 2024 · 3 comments · Fixed by #10774
Labels
area: documentation 📚 Improvements or additions to documentation area: good first issue theme: tests

Comments

@murdos
Copy link
Contributor

murdos commented Apr 26, 2024

Following #9607 : a documentation should be generated with a few examples, as done for Property-based Testing:

  • simple example
  • example with a parametrized junit test
  • example of use of combinations
@murdos murdos added area: documentation 📚 Improvements or additions to documentation area: good first issue labels Apr 26, 2024
@Harsh4902
Copy link
Contributor

@murdos I want to work on this issue. How can I proceed further?

@murdos
Copy link
Contributor Author

murdos commented Sep 3, 2024

@Harsh4902: you should read the https://github.com/approvals/ApprovalTests.java documentation in order to get familiar with it, and then add a markdown documentation to the approval-tests module, as done in the jwik module.

@Harsh4902 Harsh4902 mentioned this issue Sep 6, 2024
Merged
@Harsh4902
Copy link
Contributor

@murdos can you please review this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation 📚 Improvements or additions to documentation area: good first issue theme: tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add a small documentation for ApprovalTests Harsh4902/jhipster-lite
3 participants
@murdos @pascalgrimaud @Harsh4902