From a3e5d6ba96b0962917a13aa6ef32f6cd7d805e78 Mon Sep 17 00:00:00 2001 From: Livio Amstutz Date: Fri, 27 Aug 2021 15:26:41 +0200 Subject: [PATCH] chore: add CONTRIBUTING.md --- .../{bug-report.md => bug_report.md} | 0 CONTRIBUTING.md | 40 +++++++++++++++++++ 2 files changed, 40 insertions(+) rename .github/ISSUE_TEMPLATE/{bug-report.md => bug_report.md} (100%) create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 100% rename from .github/ISSUE_TEMPLATE/bug-report.md rename to .github/ISSUE_TEMPLATE/bug_report.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f0c8ac7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# How to contribute to the OIDC SDK for Go + +## Did you find a bug? + +Please file an issue [here](https://github.com/caos/oidc/issues/new?assignees=&labels=bug&template=bug_report.md&title=). + +Bugs are evaluated every day as soon as possible. + +## Enhancement + +Do you miss a feature? Please file an issue [here](https://github.com/caos/oidc/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=) + +Enhancements are discussed and evaluated every Wednesday by the ZITADEL core team. + +## Grab an Issues + +We add the label "good first issue" for problems we think are a good starting point to contribute to the OIDC SDK. + +* [Issues for first time contributors](https://github.com/caos/oidc/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +* [All issues](https://github.com/caos/oidc/issues) + +### Make a PR + +If you like to contribute fork the OIDC repository. After you implemented the new feature create a PullRequest in the OIDC reposiotry. + +Make sure you use semantic release: + +* feat: New Feature +* fix: Bug Fix +* docs: Documentation + +## Want to use the library? + +Checkout the [examples folder](example) for different client and server implementations. + +Or checkout how we use it ourselves in our OpenSource Identity and Access Management [ZITADEL](https://github.com/caos/zitadel). + +## **Did you find a security flaw?** + +* Please read [Security Policy](SECURITY.md). \ No newline at end of file