Merge pull request #117 from caos/workflow

chore: start improving external contribution
This commit is contained in:
Livio Amstutz 2021-08-27 15:36:51 +02:00 committed by GitHub
commit 1bd04e9f36
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 111 additions and 3 deletions

38
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,38 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

1
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1 @@
blank_issues_enabled: true

View file

@ -0,0 +1,20 @@
---
name: 🚀 Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

View file

@ -1,11 +1,18 @@
name: Release
on: push
on:
push:
branches:
- '**'
tags-ignore:
- '**'
workflow_dispatch:
jobs:
test:
runs-on: ubuntu-18.04
strategy:
matrix:
go: ['1.14', '1.15', '1.16']
go: ['1.14', '1.15', '1.16', '1.17']
name: Go ${{ matrix.go }} test
steps:
- uses: actions/checkout@v2
@ -21,6 +28,7 @@ jobs:
release:
runs-on: ubuntu-18.04
needs: [test]
if: ${{ github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main' }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:

View file

@ -1,5 +1,5 @@
module.exports = {
branch: 'master',
branch: 'main',
plugins: [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",

40
CONTRIBUTING.md Normal file
View 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).

View file

@ -46,6 +46,7 @@ For your convenience you can find the relevant standards linked below.
| 1.14 | :white_check_mark: |
| 1.15 | :white_check_mark: |
| 1.16 | :white_check_mark: |
| 1.17 | :white_check_mark: |
## Why another library