|
1 |
| -# CONTRIBUTING |
| 1 | +# Netlify CMS Widget Parent |
2 | 2 |
|
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 |
5 | 4 |
|
6 |
| -## Setup |
| 5 | +## Development |
7 | 6 |
|
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 |
20 | 10 | ```
|
21 | 11 |
|
| 12 | +## Build |
22 | 13 |
|
23 |
| -## Running the server |
24 |
| - |
25 |
| -```sh |
26 |
| -$ yarn dev |
| 14 | +```bash |
| 15 | +yarn |
| 16 | +yarn build |
27 | 17 | ```
|
28 | 18 |
|
29 |
| -## Pull Requests |
| 19 | +## Release |
30 | 20 |
|
31 |
| -We actively welcome your pull requests. |
| 21 | +Make sure you have npm + git credentials set up. |
32 | 22 |
|
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: |
38 | 28 |
|
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 | +``` |
40 | 36 |
|
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