From 735e9adbeb86ebae4936ed68899e05a111a20392 Mon Sep 17 00:00:00 2001 From: Sebastian Widmer Date: Mon, 5 Jul 2021 14:37:14 +0200 Subject: [PATCH] Add contribution guide with release instructions (#7) * Add contribution guide with release instructions * Update wording from suggestion Co-authored-by: Simon Gerber Co-authored-by: Simon Gerber --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1f3c5fb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# How to contribute + +This code repository is part of Project Syn and the contribution guide at +https://syn.tools/syn/about/contribution_guide.html does apply. + +Submit Pull Requests at https://github.com/projectsyn/getting-started-commodore-defaults/pulls. + +## Releasing + +Tags in this repository should be used to specify the [Commodore version](https://github.com/projectsyn/commodore/releases) with which the configuration has been written/tested. +The tags are used in the [Getting Started Guide](https://syn.tools/syn/tutorials/getting-started.html) to ensure a matching Commodore version and default configuration are used. + +When updating this repository, you should check if the [Getting Started Guide](https://syn.tools/syn/tutorials/getting-started.html) needs to be updated as well.