Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document branching #9983

Merged
merged 3 commits into from
Dec 7, 2018
Merged

docs: document branching #9983

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
295a54c
docs: document branching
DSchau Nov 16, 2018
cc8bf52
chore: dos2unix
DSchau Dec 7, 2018
3bd4437
Merge remote-tracking branch 'upstream/master' into docs/add-branch-info
DSchau Dec 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/docs/how-to-contribute.md
View file
Open in desktop
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