Skip to content

Commit

Permalink
docs: document branching (#9983)
Browse files Browse the repository at this point in the history
* docs: document branching

Note: I'll tweak this, want to see if the CircleCI filter stuff works

* chore: dos2unix
  • Loading branch information
DSchau authored Dec 7, 2018
1 parent 0ae4ca3 commit 0d67c42
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/docs/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Yarn is a package manager for your code, similar to [NPM](https://www.npmjs.com/
- Set up repo and install dependencies: `yarn run bootstrap`
- Make sure tests are passing for you: `yarn test`
- Create a topic branch: `git checkout -b topics/new-feature-name`
- Note: if making a docs only change, consider using `git checkout -b docs/some-change` or `git checkout -b docs-some-change`, as this will short circuit the CI process and only run linting tasks
- Run `yarn run watch` from the root of the repo to watch for changes to packages' source code and compile these changes on-the-fly as you work. Note that the watch command can be resource intensive. To limit it to the packages you're working on, add a scope flag, like `yarn run watch -- --scope={gatsby,gatsby-cli}`. To watch just one package, run `yarn run watch -- --scope=gatsby`.
- Install [gatsby-dev-cli](/packages/gatsby-dev-cli/) globally: `yarn global add gatsby-dev-cli`
- Run `yarn install` in each of the sites you're testing.
Expand Down Expand Up @@ -127,6 +128,7 @@ To add a new blog post to the gatsbyjs.org blog:
- Double check your grammar and capitalise correctly
- Commit and push to your fork
- Create a pull request from your branch
- We recommend using a prefix of `docs`, e.g. `docs/your-change` or `docs-your-change`

## Development tools

Expand Down

0 comments on commit 0d67c42

Please sign in to comment.