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 and update documentation (#8 / #40) #40

Merged
merged 6 commits into from
May 11, 2021
Merged

Add and update documentation (#8 / #40) #40

merged 6 commits into from
May 11, 2021

Conversation

Bukama
Copy link
Member

@Bukama Bukama commented Mar 27, 2021 •
edited
Loading 

This PR adds general documentation and updates some mistakes of the documentation of the issue report.

related: #8 
PR: #40

@Bukama Bukama changed the title Add and update documentation (#8 / NA ) Add and update documentation (#8 / #40) Mar 27, 2021
@Bukama Bukama requested a review from a team March 27, 2021 16:47
Michael1993
Michael1993 reviewed Apr 8, 2021
View reviewed changes
docs/issue-report.adoc
@@ -71,9 +71,11 @@ This example shows a report which include:
Several values are configurable by system properties.
Copy link
Member

Choose a reason for hiding this comment

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

Why system properties? Wouldn't a testreport.properties file (in the test resources) make more sense?

Copy link
Member Author

Choose a reason for hiding this comment

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

To be file-independent and be able to use the SystemPropertyExtension :)

docs/issue-report.adoc Show resolved Hide resolved
docs/project-page.adoc Outdated Show resolved Hide resolved
docs/project-page.adoc Outdated

The `Test Reports` provides additional information in (new) reports of the test results.
The project was initialized as the current JUnit test report can not publish additional attributes or information, e.g. values created by extensions.
The library itself does not create one single report, but provides test report provide the user can use.
Copy link
Member

Choose a reason for hiding this comment

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

This line is not clear. Does the library create test reports or not? What is a "test report provider"?

Also, I think you meant to write "but provides test report provider(s)"?

@Bukama
Copy link
Member Author

Bukama commented Apr 18, 2021

Thanks @Michael1993 Updated the parts you mentioned

@Bukama Bukama merged commit 8be066c into junit-pioneer:main May 11, 2021
@Bukama Bukama deleted the issue8/documentation branch May 11, 2021 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Michael1993 Michael1993 Michael1993 left review comments

@nipafx nipafx Awaiting requested review from nipafx

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

Successfully merging this pull request may close these issues.
2 participants
@Bukama @Michael1993