From d42b87d9e6fa5dc0e9a175626d25d14a23f1936d Mon Sep 17 00:00:00 2001 From: Nik Date: Wed, 29 Mar 2023 08:10:58 +0200 Subject: [PATCH] git: Added CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e8606a6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +# Contributing + +Contributing to the Database is very simple. Fork this repository, add your new files (or changes to existing files) to the right folders and create a PR. +When adding new files, please make sure to also add a link to them to the Table of Contents in the README.md file. That way the files can be discovered by others more easily. + +Thanks a lot for any additions or improvements :) + +## Adding new Patterns + +When adding new patterns, if possible, please also add a test file named `.hexpat.` to the `/tests/patterns/test_data` directory. This allows our Unit Tests to be run against your code so we can make sure it stays up-to-date and doesn't break when changes are made to the PatternLanguage. +Please try to keep these files as small as possible (~100kiB at most) so cloning stays fast. +Please also make sure to not submit any test files that are under copyright such as game files, ROMs or files extracted from other programs. We don't want a DMCA takedown on this repo.