chore: add CONTRIBUTING.md
This commit is contained in:
parent
d009df3567
commit
a3e5d6ba96
2 changed files with 40 additions and 0 deletions
40
CONTRIBUTING.md
Normal file
40
CONTRIBUTING.md
Normal file
|
@ -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).
|
Loading…
Add table
Add a link
Reference in a new issue