Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: align workflows, guidelines and documentation with connector repo #30

Merged
merged 4 commits into from
Aug 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Bug Report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''

---

# Bug Report

## Describe the Bug
_A clear and concise description of the bug._

### Expected Behavior
_A clear and concise description of what you expected to happen._

### Observed Behavior
_A clear and concise description of what happened instead._

## Steps to Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Context Information
_Add any other context about the problem here._

- Used version [e.g. IdentityHub v1.0.0]
- OS: [e.g. iOS, Windows]
- ...

## Detailed Description
_If applicable, add screenshots and logs to help explain your problem._

## Possible Implementation
_You already know the root cause of the erroneous state and how to fix it? Feel free to share your thoughts._
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
blank_issues_enabled: true
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature Request
about: Help us with new ideas
title: ''
labels: ''
assignees: ''

---

# Feature Request

## Which Areas Would Be Affected?
_e.g., build, extension, etc._

## Why Is the Feature Desired?
_Are there any requirements?_

## Solution Proposal
_If possible, provide a (brief!) solution proposal._

## Type of Issue
_i.e., new feature, improvement, cleanup, etc._

## Checklist

- [ ] assigned appropriate label?
- [x] **Do NOT select a milestone or an assignee!**
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Closes # <-- _insert Issue number if one exists_
- [ ] documented public classes/methods?
- [ ] added/updated relevant documentation?
- [ ] added relevant details to the changelog? (_skip with label `no-changelog`_)
- [ ] formatted title correctly? (_take a look at the [CONTRIBUTING](https://github.com/eclipse-dataspaceconnector/identityservice/blob/main/CONTRIBUTING.md#submit-a-pull-request) and [styleguide](https://github.com/eclipse-dataspaceconnector/identityservice/blob/main/styleguide.md) for details_)
- [ ] formatted title correctly? (_take a look at the [CONTRIBUTING](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/CONTRIBUTING.md#submit-a-pull-request) and [styleguide](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/styleguide.md) for details_)
34 changes: 34 additions & 0 deletions .github/workflows/pull-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Scan Pull Request

on:
pull_request:
branches: [ main ]
types: [opened, edited, synchronize, reopened, labeled, unlabeled]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
check-pull-request-title:
runs-on: ubuntu-latest
continue-on-error: false
steps:
- uses: actions/checkout@v3
- uses: deepakputhraya/action-pr-title@master
with:
# Match pull request titles conventional commit syntax (https://www.conventionalcommits.org/en/v1.0.0/)
# (online tool for regex quick check: https://regex101.com/r/V5J8kh/1)
#
# Valid examples would be
# - fix: resolve minor issue
# - docs(Sample5): update docs for configuration
# - feat(management-api)!: change path to access contract agreements
#
# Invalid examples would be
# - Add cool feature
# - Feature/some cool improvement
# - fix: resolve minor issue.
regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(\w+((,|\/|\\)?\s?\w+)+\))?!?: [\S ]{1,80}[^\.]$'
allowed_prefixes: 'build,chore,ci,docs,feat,fix,perf,refactor,revert,style,test'
prefix_case_sensitive: true
3 changes: 0 additions & 3 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@

# The linked persons are automatically added as reviewers when a pull request is opened.

CONTRIBUTING.md @paullatzelsperger
LICENSE @paullatzelsperger
pr_etiquette.md @paullatzelsperger
styleguide.md @paullatzelsperger

.github/actions/ @paullatzelsperger
.github/ISSUE_TEMPLATE @paullatzelsperger
Expand Down
212 changes: 0 additions & 212 deletions CONTRIBUTING.md

This file was deleted.

6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Temporary repository to get started with the Identity Hub for the MVD.

## Documentation

Developer documentation can be found under [docs/developer](docs/developer/), where the main concepts and decisions are captured as [decision records](docs/developer/decision-records/).

## Run and develop identity Hub locally

In order to be able to develop and run this project, you need to follow the instructions below:
Expand All @@ -25,4 +29,4 @@ If you change the contract of an endpoint or add a new one, you will need to re-

## Contributing

See [how to contribute](./CONTRIBUTING.md) for details.
See [how to contribute](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/CONTRIBUTING.md) for details.
6 changes: 6 additions & 0 deletions docs/developer/decision-records/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Decision Records

- [2022-06-08 Identity Hub](2022-06-08-identity-hub/)
- [2022-07-01 Get Claims](2022-07-01-get-claims/)
- [2022-07-29 Self-description](2022-07-29-self-description/)
- [2022-08-12 Code Quality Tooling](2022-08-12-code-quality-tooling/)
Loading