Skip to content

File tree

4 files changed

+69
-1
lines changed

4 files changed

+69
-1
lines changed
 

‎.github/workflows/release-please.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: release-please
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
release-please:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: GoogleCloudPlatform/release-please-action@v2
11+
with:
12+
token: ${{ secrets.NODE_PKG_RELEASE_TOKEN }}
13+
release-type: node
14+
package-name: '@netlify/plugin-nextjs'

‎CONTRIBUTING.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributions
2+
3+
🎉 Thanks for considering contributing to this project! 🎉
4+
5+
These guidelines will help you send a pull request.
6+
7+
If you're submitting an issue instead, please skip this document.
8+
9+
If your pull request is related to a typo or the documentation being unclear, please click on the relevant page's `Edit`
10+
button (pencil icon) and directly suggest a correction instead.
11+
12+
This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
13+
14+
Everyone is welcome regardless of personal background. We enforce a [Code of conduct](CODE_OF_CONDUCT.md) in order to
15+
promote a positive and inclusive environment.
16+
17+
## Development process
18+
19+
First fork and clone the repository. If you're not sure how to do this, please watch
20+
[these videos](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
21+
22+
Run:
23+
24+
```bash
25+
npm install
26+
```
27+
28+
Make sure everything is correctly setup with:
29+
30+
```bash
31+
npm test
32+
```
33+
34+
## How to write commit messages
35+
36+
We use [Conventional Commit messages](https://www.conventionalcommits.org/) to automate version management.
37+
38+
Most common commit message prefixes are:
39+
40+
* `fix:` which represents bug fixes, and generate a patch release.
41+
* `feat:` which represents a new feature, and generate a minor release.
42+
* `feat!:`, `fix!:` or `refactor!:` and generate a major release.
43+
44+
## Releasing
45+
46+
1. Merge the release PR
47+
2. Run `npm publish`

‎commitlint.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = { extends: ['@commitlint/config-conventional'] }

‎package.json

+7-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@
1919
"cypress:local": "env CYPRESS_DEPLOY=local cypress run --project ./src --config-file false --config video=false",
2020
"cypress:netlify": "env CYPRESS_DEPLOY=netlify cypress run --project ./src --config-file false --config video=false",
2121
"cypress:local:testonly": "env CYPRESS_SKIP_DEPLOY=true npm run cypress:local",
22-
"cypress:netlify:testonly": "env CYPRESS_SKIP_DEPLOY=true npm run cypress:netlify"
22+
"cypress:netlify:testonly": "env CYPRESS_SKIP_DEPLOY=true npm run cypress:netlify",
23+
"prepublishOnly": "run-s prepublishOnly:*",
24+
"prepublishOnly:checkout": "git checkout main",
25+
"prepublishOnly:pull": "git pull",
26+
"prepublishOnly:install": "npm ci",
27+
"prepublishOnly:test": "npm test"
2328
},
2429
"repository": {
2530
"type": "git",
@@ -70,6 +75,7 @@
7075
},
7176
"husky": {
7277
"hooks": {
78+
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
7379
"pre-commit": "prettier --check ."
7480
}
7581
},

0 commit comments

Comments
 (0)
Please sign in to comment.