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

Missing contributing documentation #1300

Closed
3 tasks done
ISSOtm opened this issue Feb 18, 2024 · 0 comments · Fixed by #1324
Closed
3 tasks done

Missing contributing documentation #1300

ISSOtm opened this issue Feb 18, 2024 · 0 comments · Fixed by #1324
Assignees
@ISSOtm @Rangi42
Labels
enhancement Typically new features; lesser priority than bugs meta This isn't related to the tools directly: repo organization, maintainership...
Milestone
v0.8.0

Comments

@ISSOtm
Copy link
Member

ISSOtm commented Feb 18, 2024 •
edited by Rangi42

  • Reformat to Markdown for easier modification?
  • How to run the test suite
  • How to add tests to the suite

Is there more that's missing?
@ISSOtm ISSOtm added enhancement Typically new features; lesser priority than bugs meta This isn't related to the tools directly: repo organization, maintainership... labels Feb 18, 2024
@Rangi42 Rangi42 added this to the v0.7.1 milestone Feb 18, 2024
@Rangi42 Rangi42 mentioned this issue Feb 18, 2024
Merged
@Rangi42 Rangi42 self-assigned this Feb 18, 2024
ISSOtm added a commit to ISSOtm/rgbds that referenced this issue Mar 1, 2024
@ISSOtm
Document how to add tests
b81ebb3 
Fixes gbdev#1300's last remaining item.
Also add `checkdiff` rules to remind us to update that doc if
any of the test driver scripts are updated.
@ISSOtm ISSOtm mentioned this issue Mar 1, 2024
Merged
ISSOtm added a commit to ISSOtm/rgbds that referenced this issue Mar 1, 2024
@ISSOtm
Document how to add tests
5471a7b 
Fixes gbdev#1300's last remaining item.
Also add `checkdiff` rules to remind us to update that doc if
any of the test driver scripts are updated.
Rangi42 pushed a commit that referenced this issue Mar 4, 2024
@ISSOtm
Improve tests a little (#1324)
0da2168 
* Avoid redirecting error messages in RGBLINK tests

We check that RGBLINK prints nothing to stdout, so all that
would be captured on stdout is a putative failure message.

* Require each RGBLINK test to check error output

Otherwise, you can have a test that just... checks nothing!

* Document how to add tests

Fixes #1300's last remaining item.
Also add `checkdiff` rules to remind us to update that doc if
any of the test driver scripts are updated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ISSOtm ISSOtm

@Rangi42 Rangi42

Labels
enhancement Typically new features; lesser priority than bugs meta This isn't related to the tools directly: repo organization, maintainership...
Projects
None yet
Milestone
v0.8.0
Development

Successfully merging a pull request may close this issue.

Improve tests a little ISSOtm/rgbds
2 participants
@ISSOtm @Rangi42