From 805d1f8bae488d1bac543a27476944f7a6f7111e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Sch=C3=B6nauer?= <37108907+DottoDev@users.noreply.github.com> Date: Wed, 19 Oct 2022 10:55:09 +0200 Subject: [PATCH] Adds Contribution paragraphs to README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 24cb375b..72d0d8ce 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,15 @@ The configuration should be placed in the following paths depending by the opera * **Windows** - `%APPDATA%/topgrade.toml` * **macOS** and **other Unix systems** - `${XDG_CONFIG_HOME:-~/.config}/topgrade.toml` +## Contribution +### Problems or missing features? +Open a new Issue describing your problem and if possible with a possible solution. +### Missing a feature or found an unsupported tool/distro? +Just let us now what you are missing by opening an issue. +For tools please open an Issue describing the tool, which platforms it supports and if possible, give us an example of its usage. +### Want to contribute to the code? +Just fork the repository and start coding. Please let PRs with bug fixes target the staging branch and PRs with new features target the dev branch. + ## Remote execution You can specify a key called `remote_topgrades` in the configuration file. This key should contain a list of hostnames that have topgrade installed on them.