Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Test to ensure README is up-to-date #678

Open
mattldawson opened this issue Oct 11, 2024 · 0 comments
Open

Test to ensure README is up-to-date #678

mattldawson opened this issue Oct 11, 2024 · 0 comments
Labels
good first issue Good for newcomers
Milestone

Comments

@mattldawson
Copy link
Collaborator

Currently there is a test in test/tutorial/test_README_example.cpp that tests whether the README example builds and runs, but there is no test to ensure that this code matches what is in the README, that the compile and run instructions in the README work, and that the results shown in the REAMDE match what is output. Add a test to check these.

Acceptance Criteria

  • If the README example fails to build or run with the compile and run instructions shown in the README a test fails
  • If the results shown in the README do not match the results of actually building and running the example shown following the instructions, a test fails.
@mattldawson mattldawson added the good first issue Good for newcomers label Oct 11, 2024
@mattldawson mattldawson added this to the Tech Debt milestone Oct 11, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant