Skip to content

Commit

Permalink
Add contribution guide with release instructions (#7)
Browse files Browse the repository at this point in the history
* Add contribution guide with release instructions

* Update wording from suggestion

Co-authored-by: Simon Gerber <simon.gerber@vshn.ch>

Co-authored-by: Simon Gerber <simon.gerber@vshn.ch>
  • Loading branch information
bastjan and simu authored Jul 5, 2021
1 parent ec9bba6 commit 735e9ad
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 735e9ad

Please sign in to comment.