Skip to content

Commit

Permalink
chore(docs): Changes to "Setting Up Your Local Dev Environment" doc (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
LekoArts authored and KyleAMathews committed Jul 29, 2020
1 parent d3ef12d commit 600e53e
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 11 deletions.
28 changes: 19 additions & 9 deletions docs/contributing/setting-up-your-local-dev-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Yarn is a package manager for your code, similar to [npm](https://www.npmjs.com/
}
```

## Gatsby repo install instructions
## Gatsby repo instructions

### Install Node and Yarn

Expand All @@ -32,15 +32,15 @@ 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`

### Docs only changes

- See [docs setup instructions](/contributing/docs-contributions#docs-site-setup-instructions) for docs-only changes.
- 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`.

### Docs only changes

- See [docs setup instructions](/contributing/docs-contributions#docs-site-setup-instructions) for docs-only changes.

### Gatsby functional changes

- Install [gatsby-cli](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-cli):
Expand Down Expand Up @@ -82,12 +82,22 @@ If you're adding e2e tests and want to run them against local changes:
- Run `gatsby-dev` inside your specific e2e test directory, for example `e2e-tests/themes/development-runtime`.
- While the previous step is running, open a new terminal window and run `yarn test` in that same e2e test directory.

### Troubleshooting

At any point during the contributing process the Gatsby team would love to help! For help with a specific problem you can [open an issue on GitHub](/contributing/how-to-file-an-issue/). Or drop in to [our Discord server](https://gatsby.dev/discord) for general community discussion and support.

- When you went through the initial setup some time ago and now want to contribute something new, you should make sure to [sync your fork](#sync-your-fork) with the latest changes from the primary branch on [gatsbyjs/gatsby](https://github.com/gatsbyjs/gatsby). Otherwise, you might run into issues where files are not found as they were renamed, moved, or deleted.
- After syncing your fork, run `yarn run bootstrap` to compile all packages. When files or tests depend on the build output (files in `/dist` directories) they might fail otherwise.
- Make sure to run `yarn run watch` on the packages' source code you're changing.

## Additional information

### Commits and pull requests

- Commit and push to your fork.
- Create a pull request from your branch.
- GitHub Help Page: [Using Git](https://docs.github.com/en/github/using-git)
- GitHub Help Page: [Proposing changes to your work with pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)

### Sync your fork

- GitHub Help Page [Syncing a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)
- GitHub Help Page [Merging an upstream repository into your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork)
- GitHub Help Page: [Syncing a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)
- GitHub Help Page: [Merging an upstream repository into your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork)
4 changes: 2 additions & 2 deletions www/src/data/sidebars/contributing-links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@
link: /contributing/blog-contributions/
- title: Code Contributions
link: /contributing/code-contributions/
- title: Website Contributions
link: /contributing/website-contributions/
items:
- title: Setting Up Your Local Dev Environment
link: /contributing/setting-up-your-local-dev-environment/
- title: Website Contributions
link: /contributing/website-contributions/
- title: Community Contributions
link: /contributing/community-contributions/
items:
Expand Down

0 comments on commit 600e53e

Please sign in to comment.