From 8d720fd7ca15160c52b892b26c93023df301b539 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Mon, 4 Jan 2021 16:48:00 +0100 Subject: [PATCH] docs: add contributing information --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ README.md | 3 ++- 2 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c471f59 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +## Security + +If you think you have found a **security issue**, please do not mention it in this repository. +Instead, send an email to security@thegeeklab.de with as many details as possible so it can be handled confidential. + +## Bug Reports and Feature Requests + +If you have found a **bug** or have a **feature request** please use the search first in case a similar issue already exists. +If not, please create an issue in this repository + +## Code + +If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request. + +Before you start any Pull Request, it is recommended that you create an issue to discuss first if you have any +doubts about requirement or implementation. That way you can be sure that the maintainer(s) agree on what to change and how, +and you can hopefully get a quick merge afterwards. + +Pull Requests can only be merged once all status checks are green. + +## Do not force push to your Pull Request branch + +Please do not force push to your Pull Requests branch after you have created your Pull Request, as doing so makes it harder for us to review your work. +Pull Requests will always be squashed by us when we merge your work. Commit as many times as you need in your Pull Request branch. + +## Re-requesting a review + +Please do not ping your reviewer(s) by mentioning them in a new comment. Instead, use the re-request review functionality. +Read more about this in the [GitHub docs, Re-requesting a review](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#re-requesting-a-review). diff --git a/README.md b/README.md index f61c860..a47d4ce 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,8 @@ somevalue ## Contributors -Special thanks goes to all [contributors](https://github.com/thegeeklab/url-parser/graphs/contributors). +Special thanks goes to all [contributors](https://github.com/thegeeklab/url-parser/graphs/contributors). If you would like to contribute, +please see the [instructions](https://github.com/thegeeklab/url-parser/blob/master/CONTRIBUTING.md). ## License