Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Sylvie <[email protected]>
  • Loading branch information
ISSOtm and Rangi42 authored Mar 3, 2024
1 parent 5f0afd4 commit 5b637ab
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Feel free to modify how the test scripts work, if the thing you want to test doe
Each `.asm` file corresponds to one test.
RGBASM will be invoked on the `.asm` file with all warnings enabled.

If a `.out` file exists, RGBASM's output (`println` etc.) must match its contents.
If a `.out` file exists, RGBASM's output (`print`, `println`, etc.) must match its contents.
If a `.err` file exists, RGBASM's error output (`warn`, errors, etc.) must match its contents.

If a `.out.bin` file exists, the object file will be linked, and the generated ROM truncated to the length of the `.out.bin` file.
Expand All @@ -95,7 +95,8 @@ All tests begin by assembling the `.asm` file into an object file, which will be

#### Simple tests

These simply check that RGBLINK's output matches... *something*.
These simply check that RGBLINK's output matches some expected output.

A `.out` file **must** exist, and RGBLINK's output must match that file's contents.

Additionally, if a `.out.bin` file exists, the `.gb` file generated by RGBLINK must match it.
Expand Down Expand Up @@ -137,10 +138,10 @@ If one *does* exist, RGBGFX's return status is ignored, but its output **must**

### Downstream projects

1. Make sure the downstream project supports <code>make <var>&lt;target&gt;</var> RGBDS=<var>&lt;path to RGBDS&gt;</var></code>.
While the test suite supports any Make target name, only [Make](//gnu.org/software/make) is currently supported, and the Makefile must support a `RGBDS` variable to use a non-system RGBDS.
1. Make sure the downstream project supports <code>make <var>&lt;target&gt;</var> RGBDS=<var>&lt;path/to/RGBDS/&gt;</var></code>.
While the test suite supports any Make target name, only [Make](//gnu.org/software/make) is currently supported, and the Makefile must support a `RGBDS` variable to use a non-system RGBDS directory.

Only projects hosted on GitHub are currently supported, too.
Also, only projects hosted on GitHub are currently supported.
2. Add the project to `test/fetch-test-deps.sh`: add a new `action` line at the bottom, following the existing pattern:

```sh
Expand All @@ -151,5 +152,5 @@ If one *does* exist, RGBGFX's return status is ignored, but its output **must**
3. Add the project to `test/run-tests.sh`: add a new `test_downstream` line at the bottom, following the existing pattern:

```sh
test_downstream <repo> <makefile target>
test_downstream <repo> <makefile target>
```

0 comments on commit 5b637ab

Please sign in to comment.