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

Improve testing developement documentation #1260

Closed
mwestphal opened this issue Feb 4, 2024 · 7 comments
Closed

Improve testing developement documentation #1260

mwestphal opened this issue Feb 4, 2024 · 7 comments
Assignees
@kidharb
Labels
help wanted Please help with this issue!
Milestone
2.5.0

Comments

@mwestphal
Copy link
Contributor

Context
F3D has a short doc about adding tests when contributing: https://f3d.app/doc/dev/TESTING.html
This doc could be expanded and improved so that new developpers have a easier time figuring it out.

Suggested solution

  • Expand the current doc to cover all usecases, especially the bit about interaction test and recover baseline from CI

Skills

  • Markdown
@mwestphal mwestphal added type:documentation help wanted Please help with this issue! labels Feb 4, 2024
@mwestphal mwestphal added this to F3D Feb 4, 2024
@mwestphal mwestphal mentioned this issue Feb 4, 2024
Closed
@mwestphal mwestphal added this to the 2.4.0 milestone Feb 4, 2024
@mwestphal mwestphal moved this to To do in F3D Feb 4, 2024
@mwestphal mwestphal mentioned this issue Feb 8, 2024
Merged
@kidharb
Copy link
Contributor

kidharb commented Mar 18, 2024

Please assign this to me

@mwestphal
Copy link
Contributor Author

any news on this one @kidharb ?

@kidharb
Copy link
Contributor

kidharb commented Mar 30, 2024

I have entered a rabbit, ie I am learning cmake as well as the testing environment in f3d.
I will start improving the docs soon.

@mwestphal mwestphal modified the milestones: 2.4.0, 2.5.0 Apr 4, 2024
@mwestphal mwestphal mentioned this issue Apr 4, 2024
Closed
@mwestphal
Copy link
Contributor Author

Any ongoing work on that @kidharb ? :)

@kidharb
Copy link
Contributor

kidharb commented Apr 21, 2024 •
edited
Loading

Thanks for following up.

In addition to the above mentioned topics of retrieving baselines and interactive testing, I will also cover recording tests cases and abit about how the testing framework is implemented with cmake.
I should have something by the end of this week

@mwestphal
Copy link
Contributor Author

Awesome!

@kidharb kidharb mentioned this issue Apr 29, 2024
Merged
@mwestphal mwestphal moved this from To do to In progress in F3D May 1, 2024
@kidharb
Copy link
Contributor

kidharb commented May 3, 2024

Can we close this issue?

@github-project-automation github-project-automation bot moved this from In progress to Done in F3D May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kidharb kidharb

Labels
help wanted Please help with this issue!
Projects
F3D
Status: Done
Milestone
2.5.0
Development

No branches or pull requests
2 participants
@mwestphal @kidharb