Skip to content

Commit df9ebf0

Browse files
committed
create the contributing.md files and set up the github workflow for releases
1 parent b2f9226 commit df9ebf0

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# How to Contribute
2+
3+
We want your help to make the Webstore Component Library great. There are a few guidelines that we need contributors to follow so that
4+
we can have a chance of keeping on top of things.
5+
6+
## Contribution Tasks
7+
8+
* Reviewing and Merging Changes
9+
10+
### Reviewing and Merging Changes
11+
12+
1. Approval Required - Github enforces at least one person approve a pull request.
13+
2. Required Labels - an appropriate [semver](https://semver.org/) label (see [release.yml](https://github.com/samvera/hyku/blob/main/.github/release.yml))
14+
15+
If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (preferably the pull request submitter) may merge the code.

.github/workflows/release.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- ignore-for-release
5+
categories:
6+
- title: Breaking Changes 🛠
7+
labels:
8+
- major-ver
9+
- title: Exciting New Features 🎉
10+
labels:
11+
- minor-ver
12+
- title: Bug Fixes 🐞
13+
labels:
14+
- patch-ver
15+
- title: Database Changes
16+
labels:
17+
- database-changes
18+
- title: Other Changes
19+
labels:
20+
- '*'

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# How to Contribute
2+
3+
We want your help to make the Webstore Component Library great. There are a few guidelines that we need contributors to follow so that
4+
we can have a chance of keeping on top of things.
5+
6+
## Contribution Tasks
7+
8+
* Reviewing and Merging Changes
9+
10+
### Reviewing and Merging Changes
11+
12+
1. Approval Required - Github enforces at least one person approve a pull request.
13+
2. Required Labels - an appropriate [semver](https://semver.org/) label (see [release.yml](https://github.com/samvera/hyku/blob/main/.github/release.yml))
14+
15+
If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (preferably the pull request submitter) may merge the code.

0 commit comments

Comments
 (0)