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

Create a text file report #93

Open
wyhasany opened this issue May 15, 2021 · 1 comment
Open

Create a text file report #93

wyhasany opened this issue May 15, 2021 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@wyhasany
Copy link
Contributor

I have following idea. When you write test cases as a documentation (see Kevlin Henney presentation https://www.youtube.com/watch?v=Qhz7cQQVBv4) you could be interested to generate some html page based on your integration tests describing technically how actually your test works. It would be nice to create asciidoc snippets per every test class. After all it could be used to compile full technical documentation. E.g. it could be useful for Spring Docs. Thanks to that you can keep your documentation always fresh. @JoseLion Let me know wdyt about it?

@JoseLion
Copy link
Owner

@wyhasany, I think I see what you mean. I'm familiar with writing test cases as documentation. I think doing BDD is the best tool for that. Actually, that was one of the reasons for writing this plugin. 😁

If I understood correctly, you propose that the plugin could also generate asciidoc snippets based on the description of each test case. Is that correct? I think that would be a nice extra feature, and we can use the extension to enable it and add some customizations.

If you already have an idea of how to start implementing this, PRs are always welcome. We can start with something small and add more features to it progresively. 🙂

@JoseLion JoseLion added enhancement New feature or request help wanted Extra attention is needed labels Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants