Skip to content

Commit d98943d

Browse files
committed
docs: update contributing docs
1 parent d82fdd7 commit d98943d

File tree

1 file changed

+25
-30
lines changed

1 file changed

+25
-30
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,37 @@
1-
# CONTRIBUTING
1+
# Netlify CMS Widget Parent
22

3-
Contributions are always welcome, no matter how large or small. Before contributing,
4-
please read the [code of conduct](CODE_OF_CONDUCT.md).
3+
A Netlify CMS widget to select directory parent for an entry
54

6-
## Setup
5+
## Development
76

8-
> Install yarn on your system: https://yarnpkg.com/en/docs/install
9-
10-
```sh
11-
$ git clone https://github.com/netlify/netlify-identity-widget
12-
$ cd netlify-identity-widget
13-
$ yarn
14-
```
15-
16-
## Building
17-
18-
```sh
19-
$ yarn build
7+
```bash
8+
yarn
9+
yarn develop
2010
```
2111

12+
## Build
2213

23-
## Running the server
24-
25-
```sh
26-
$ yarn dev
14+
```bash
15+
yarn
16+
yarn build
2717
```
2818

29-
## Pull Requests
19+
## Release
3020

31-
We actively welcome your pull requests.
21+
Make sure you have npm + git credentials set up.
3222

33-
1. Fork the repo and create your branch from `master`.
34-
2. If you've added code that should be tested, add tests.
35-
3. If you've changed APIs, update the documentation.
36-
4. Ensure the test suite passes.
37-
5. Make sure your code lints.
23+
- [ ] Make changes and/or merge PRs.
24+
- [ ] `git checkout master`
25+
- [ ] `git pull`
26+
- [ ] `yarn`
27+
- [ ] Set up semantic release environment variables:
3828

39-
## License
29+
```bash
30+
export GIT_AUTHOR_NAME=<your-github-login>
31+
export GIT_AUTHOR_EMAIL=<your-github-email>
32+
export GIT_COMMITTER_NAME=<your-github-login>
33+
export GIT_COMMITTER_EMAIL=<your-github-email>
34+
export GITHUB_TOKEN=<github-token-with-public_repo-permissions>
35+
```
4036

41-
By contributing to Netlify Identity Widget, you agree that your contributions will be licensed
42-
under its [MIT license](LICENSE).
37+
- [ ] `npm run release`

0 commit comments

Comments
 (0)