From 64f620df7755b8adf6ec3600fd99c379e004fc14 Mon Sep 17 00:00:00 2001 From: Sebastian Hildebrandt Date: Tue, 2 Jun 2020 08:04:54 +0200 Subject: [PATCH] updated contributing docs --- docs/CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index a868629..c73b640 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,12 +1,12 @@ ## You want to contribute some code? -We are always looking for quality contributions and will be happy to accept your Pull Requests as long as they adhere to some basic rules: +First of all: thank you for contributing to this repository. We are always looking for quality contributions and will be happy to accept your pull requests as long as they adhere to some basic rules: * Please make sure that your contribution fits well in the project's context: - * we are aiming to provide a high quality multi platform system information library, without any dependencies on any external JavaScript library; - * the only dependency should be bootstrap CSS and its markup structure - + * We are aiming to provide a high quality multi platform system information library. + * This package should stay without any dependencies on any external JavaScript library. + * Please assure that you are submitting quality code, specifically make sure that: - * your commits should not be braking changes - if possible. - * your PR are well testet - if possible on multiple platforms / machines - * if your commit needs a major version bump (breaking change), please leave a clear message in your comments + * Your commits should not be braking changes - if possible. + * Your PR are well testet - if possible on multiple platforms / machines (please provide information against what systems it was tested). + * If your commit needs a major version bump (breaking change), please leave a clear message in your comments. We try to keep the breaking changes as low as possible to avoid compatibility issues.