aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <mssola@mssola.com>2026-07-22 16:53:21 +0200
committerMiquel Sabaté Solà <mssola@mssola.com>2026-07-22 16:53:21 +0200
commit421fdaa6a558540e1627d21cd69453860a2aaeee (patch)
tree9eea9a57aaff557554b31dd385e821b779371c1b /CONTRIBUTING.md
parentac36786e9e4a3a4b98eb128f10220ed22b66c4d9 (diff)
downloadjetpac.nes-421fdaa6a558540e1627d21cd69453860a2aaeee.tar.gz
jetpac.nes-421fdaa6a558540e1627d21cd69453860a2aaeee.zip
Update links to git.mssola.comHEADmain
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md27
1 files changed, 6 insertions, 21 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 63ee683..270b234 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,31 +8,15 @@ 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/jetpac.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 game 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.
+[Like this](https://jo.mssola.com/en/contributing.html).
## Tooling
In general, rely on `make deps` to tell you what you need for development. Other
than that, if you are typing code, follow [this code
-style](https://github.com/mssola/style.nes). It's what I'm trying to follow here
-and it plays well with the tooling I have on
-[tools.nes](https://github.com/mssola/tools.nes).
+style](https://git.mssola.com/nes/style.nes). It's what I'm trying to follow
+here and it plays well with the tooling I have on
+[tools.nes](https://git.mssola.com/nes/tools.nes).
## Development cycle
@@ -50,7 +34,8 @@ In order to test your changes, I'd go this way:
You can pass the following arguments to `make`:
- `CC65`: the compiler to use (defaults to
- [xa65](https://github.com/mssola/tools.nes) if that exists, otherwise `cl65`).
+ [xa65](https://git.mssola.com/nes/tools.nes) if that exists, otherwise
+ `cl65`).
- `CCOPTS`: the options to use for the compiler (defaults to `--target nes` and
it adds `--strict` if using `xa65`).
- `RUBY`: the ruby to use (defaults to `ruby`).