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.

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

Improve readme for JUnit #257

Open
mleegwt opened this issue Jan 5, 2024 · 3 comments
Open

Improve readme for JUnit #257

mleegwt opened this issue Jan 5, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mleegwt
Copy link
Contributor

mleegwt commented Jan 5, 2024

Currently the examples in the readme only use JUnit 4. JUnit 5 is not mentioned at all.
I would suggest to choose one of the following options:

  • Add JUnit 5 support
  • Add JUnit 5 support and reduce visibility of JUnit 4 by only linking to the JUnit 4 examples.
  • Replace JUnit 4 by JUnit 5 examples and not mention JUnit 4 at all

What is the best option?

@dajudge
Copy link
Owner

dajudge commented Feb 12, 2024

Hi @mleegwt,

thanks for bringing this up!

Indeed it's about time to have JUnit 5 docs available. I'd probably go for having both variants on the README with the JUnit 5 version coming first.

WDYT?

@dajudge dajudge self-assigned this Feb 12, 2024
@dajudge dajudge added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 12, 2024
@mleegwt
Copy link
Contributor Author

mleegwt commented Feb 12, 2024

Hi @dajudge,

Sounds like a great option!

@dajudge
Copy link
Owner

dajudge commented Feb 12, 2024

Would you be interested in making a contribution to the README along those lines?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants