From 9e22faffffa20aa256a05468157404006e2e4d1e Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Thu, 21 Dec 2023 00:02:51 +0100 Subject: Initial commit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Implemented the List scope which brings some handy macros and functions to manipulate big lists on the NES. Signed-off-by: Miquel Sabaté Solà --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0baab7f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +## Why? + +Do you want to fix an error you have found? Do you know a way to improve my +6502-fu or do you know a technique on NES development that might help here? I am +open for discussion and welcome any help! + +## How? + +There are many ways to help me out. One way might be to open an issue on +[Github's tracker](https://github.com/mssola/list.nes/issues) and start a +discussion. For this, mind the following: + +- Check that the issue has not already been reported or fixed in `main`. +- Try to be concise and precise in your description. +- If you have found a problem, provide a step by step guide on how to reproduce it. +- Provide the version you are using (git commit SHA), as well as the version of + the toolchain and the emulator/system being used. + +Another way is to simply submit a pull request. For this, also mind these: + +- Write a [good commit message](https://chris.beams.io/posts/git-commit/). +- You are sure that `make` continues to work. +- The pull request has *only* one subject and a clear title. You are not + submitting a pull request with tons of different unrelated commits. -- cgit v1.2.3