Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.
Install yarn on your system: https://yarnpkg.com/en/docs/install
Only required on the first run, subsequent runs can use
yarn
to both bootstrap and run the development server usingyarn develop
. Since this starter using the netlify-dev, there could be further issues you, please check the netlify-dev repository for further information and set up questions.
$ git clone https://github.com/netlify-templates/gatsby-starter-netlify-cms
$ yarn
Build the static files into the public
folder, turns lambda functions into a deployable form.
$ yarn build
Runs gatsby clean
command.
yarn clean
Starts the netlify dev environment, including the gatsby dev environment. For more infor check the Netlify Dev Docs
netlify dev
Runs the clean
script and starts the gatsby develop server using the command gatsby develop
. We recomend using this command when you don't need Netlify specific features
yarn develop
Not implmented yet
yarn test
Formats code and docs according to our style guidelines using prettier
yarn format
We actively welcome your pull requests!
If you need help with Git or our workflow, please ask on Gitter.im. We want your contributions even if you're just learning Git. Our maintainers are happy to help!
Netlify CMS uses the Forking Workflow + Feature Branches. Additionally, PR's should be rebased on master when opened, and again before merging.
- Fork the repo.
- Create a branch from
master
. If you're addressing a specific issue, prefix your branch name with the issue number. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Run
yarn test
and ensure the test suite passes. (Not applicable yet) - Use
yarn format
to format and lint your code. - PR's must be rebased before merge (feel free to ask for help).
- PR should be reviewed by two maintainers prior to merging.
By contributing to the Gatsby - Netlify CMS starter, you agree that your contributions will be licensed under its MIT license.