8000 ci: document and enforce our contribution protocols by becomingbabyman · Pull Request #13 · homebaseio/homebase-react · GitHub
[go: up one dir, main page]

Skip to content

ci: document and enforce our contribution protocols #13

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

Merged
merged 3 commits into from
Nov 12, 2020
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
1 change: 1 addition & 0 deletions .husky/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_
4 changes: 4 additions & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname $0)/_/husky.sh"

yarn commitlint -e "$(git rev-parse --git-dir)/COMMIT_EDITMSG"
7 changes: 7 additions & 0 deletions .husky/prepare-commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/sh
. "$(dirname $0)/_/husky.sh"

NOCOLOR='\033[0m'
PURPLE='\033[1;35m'
exec < /dev/tty && yarn git-cz --hook ||
echo "${PURPLE}FIX: Try upgrading git, --absolute-git-dir was introduced in v2.13${NOCOLOR}" && true
4 changes: 0 additions & 4 deletions CHANGELOG.md

This file was deleted.

21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contribution guide

## Developing homebase-react

If you consider contributing changes to homebase-react – thank you!
Please review these guidelines when filing a pull request:

- Commits follow the [Angular commit convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
- 2 spaces indentation
- Features and bug fixes should be covered by test cases

## Creating releases

homebase-react uses [semantic-release](https://github.com/semantic-release/semantic-release)
to release new versions automatically on merge to master.

- Commits of type `fix` will trigger bugfix releases, think `0.0.1`
- Commits of type `feat` will trigger feature releases, think `0.1.0`
- Commits with `BREAKING CHANGE` in body or footer will trigger breaking releases, think `1.0.0`

All other commit types will trigger no new release.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ yarn install
yarn test
```

## Contributing

Welcome and thank you! Writing docs, patches and features are all incredibly helpful and appreciated.

We only ask that you provide test coverage for code changes, and conform to our [commit guidelines](CONTRIBUTING.md).

## Authors

Expand Down
1 change: 1 addition & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = {extends: ['@commitlint/config-conventional']}
33 changes: 24 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"license": "MIT",
"homepage": "https://github.com/homebaseio/homebase-react",
"main": "./dist/js/homebase.react.js",
"private": false,
"scripts": {
"dev": "shadow-cljs watch dev",
"build": "rm -rf dist && shadow-cljs release npm",
Expand All @@ -15,7 +16,15 @@
"test": "yarn test:cljs && yarn test:js",
"test:dev": "yarn test:cljs && yarn test:js:dev",
"report": "rm -rf dist && shadow-cljs run shadow.cljs.build-report npm report.html",
"semantic-release": "semantic-release"
"semantic-release": "semantic-release",
"_postinstall": "husky install",
"prepublish": "pinst --disable",
"postpublish": "pinst --enable"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"peerDependencies": {
"react": ">=16.8.0"
Expand All @@ -25,24 +34,30 @@
"@babel/core": "7.11.6",
"@babel/plugin-transform-modules-commonjs": "7.12.1",
"@babel/plugin-transform-react-jsx": "7.10.4",
"@semantic-release/changelog": "^5.0.1",
"@semantic-release/commit-analyzer": "^8.0.1",
"@semantic-release/git": "^9.0.0",
"@semantic-release/github": "^7.1.1",
"@semantic-release/npm": "^7.0.6",
"@semantic-release/release-notes-generator": "^9.0.1",
"@commitlint/cli": "^11.0.0",
"@commitlint/config-conventional": "^11.0.0",
"@semantic-release/changelog": "5.0.1",
"@semantic-release/commit-analyzer": "8.0.1",
"@semantic-release/git": "9.0.0",
"@semantic-release/github": "7.1.1",
"@semantic-release/npm": "7.0.6",
"@semantic-release/release-notes-generator": "9.0.1",
"babel-runtime": "6.26.0",
"commitizen": "^4.2.2",
"create-react-class": "15.6.3",
"cz-conventional-changelog": "^3.3.0",
"enzyme": "3.11.0",
"enzyme-adapter-react-16": "1.15.5",
"highlight.js": "10.2.1",
"husky": "5.0.0-beta.0",
"jest": "26.6.0",
"marked": "1.2.0",
"pinst": "2.0.0",
"react": "16.14.0",
"react-component-benchmark": "0.0.4",
"react-dom": "16.14.0",
"semantic-release": "^17.2.2",
"semantic-release-cli": "^5.4.0",
"semantic-release": "17.2.2",
"semantic-release-cli": "5.4.0",
"shadow-cljs": "2.11.4"
},
"keywords": [
Expand Down
Loading
0