lhearachel/nitrorom
1
Fork 0
mirror of https://github.com/lhearachel/nitrorom.git synced 2025-06-19 14:05:33 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Add table-of-contents to CONTRIBUTING.md

Browse Source
This commit is contained in:
Rachel 2025-04-20 17:24:18 -07:00
parent 27f4ba3e77
commit f4517bf8c3
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -4,11 +4,17 @@ Thanks for your interest in contributing! This project is largely a solo-effort,
but collaborative effort is always appreciated. ❤️ but collaborative effort is always appreciated. ❤️
Here, you'll find a loose set of guidelines for contributing to NitroROM. These Here, you'll find a loose set of guidelines for contributing to NitroROM. These
are not *rules*; use your best judgment and feel free to propose changes to this are not _rules_; use your best judgment and feel free to propose changes to this
document by way of a pull request. document by way of a pull request.
## Table of Contents ## Table of Contents
- [Table of Contents](#table-of-contents)
- [How do I report a bug or a crash?](#how-do-i-report-a-bug-or-a-crash)
- [How do I set up a development environment?](#how-do-i-set-up-a-development-environment)
- [How do I run automated tests?](#how-do-i-run-automated-tests)
- [How do I submit an enhancement / bugfix?](#how-do-i-submit-an-enhancement-bugfix)
## How do I report a bug or a crash? ## How do I report a bug or a crash?
First, make sure that you have a debug-build of the program. You can verify this First, make sure that you have a debug-build of the program. You can verify this
@ -61,7 +67,7 @@ Meson comes with a built-in test harness. Code for the drivers is stored in the
by the `test_suites` dictionary in `tests/meson.build`, which maps module-suites by the `test_suites` dictionary in `tests/meson.build`, which maps module-suites
to their driver and associated test cases. to their driver and associated test cases.
To *run* the full test-suite: To _run_ the full test-suite:
```sh ```sh
meson test -C build meson test -C build