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.

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

[SYNC] #3

Merged
merged 67 commits into from
Dec 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
5d3f6ef
Update from gatsbyjs/gatsby
gatsbybot Nov 6, 2019
3963b8a
sync with monorepo gatsbyjs/gatsby@5d3f6efbff8feee08e63a3ba7d7fb2cdf1…
gatsbybot Nov 7, 2019
0734df4
sync with monorepo gatsbyjs/gatsby@1acac83c928dd46e245d37e77aee878bfd…
gatsbybot Nov 8, 2019
82b9050
sync with monorepo gatsbyjs/gatsby@ac5af971c83a71e65087c85906c31ebfe8…
gatsbybot Nov 10, 2019
d98836e
sync with monorepo gatsbyjs/gatsby@7447d10846a0c5f703454f21c991738ecf…
gatsbybot Nov 10, 2019
89288cf
sync with monorepo gatsbyjs/gatsby@149f0d204db772ca7a7b25815bc49259b3…
gatsbybot Nov 10, 2019
2cb23d9
sync with monorepo gatsbyjs/gatsby@f488d4a82eae0c7e0aae7d47052f2fc204…
gatsbybot Nov 10, 2019
c378540
sync with monorepo gatsbyjs/gatsby@eb165e34e8ec828610fcfbc1a60ea136f5…
gatsbybot Nov 11, 2019
5b77b58
sync with monorepo gatsbyjs/gatsby@702f8e1787d5b163856e23e45efe2d7a6a…
gatsbybot Nov 12, 2019
09dde32
sync with monorepo gatsbyjs/gatsby@5bbf527ee4630e67f2fac5e5c5ba597c18…
gatsbybot Nov 12, 2019
61596b8
sync with monorepo gatsbyjs/gatsby@16adf6075aeb5cc1aa3ce48885810167f6…
gatsbybot Nov 12, 2019
d65e06f
sync with monorepo gatsbyjs/gatsby@2b48c10a3c855ad1a3b25b8010cbb2ae50…
gatsbybot Nov 12, 2019
b5075d8
sync with monorepo gatsbyjs/gatsby@67f9740684f6987aab13845ed4c03a8114…
gatsbybot Nov 12, 2019
c31efa0
sync with monorepo gatsbyjs/gatsby@ce0c7b44c82321f19ef486a340e1e61c2a…
gatsbybot Nov 12, 2019
3b97aa7
sync with monorepo gatsbyjs/gatsby@5eef712db33576642ca2b53f4cb48c8cc2…
gatsbybot Nov 12, 2019
5c1c178
sync with monorepo gatsbyjs/gatsby@9e014763369f06a4ed1d8d3422bd31217e…
gatsbybot Nov 13, 2019
4d645b8
sync with monorepo gatsbyjs/gatsby@72128a43e9145d0a4c89e615004bdc7e9a…
gatsbybot Nov 13, 2019
81d46d1
sync with monorepo gatsbyjs/gatsby@52be765c56f7fdeabb18e46b4c3facfdf6…
gatsbybot Nov 13, 2019
2941e45
sync with monorepo gatsbyjs/gatsby@9047cad704b47bb1273dacadb9c724477b…
gatsbybot Nov 13, 2019
5ea27ce
sync with monorepo gatsbyjs/gatsby@4db2ff1835b7de06092f3b59dfc3aeddec…
gatsbybot Nov 13, 2019
b13148f
sync with monorepo gatsbyjs/gatsby@337bbd01abf58f27560416e34fd6ba8ce5…
gatsbybot Nov 13, 2019
4aced79
sync with monorepo gatsbyjs/gatsby@9d37452d485273d78fe3a18a49d4ba7adf…
gatsbybot Nov 14, 2019
badffc6
sync with monorepo gatsbyjs/gatsby@2aae4e6486a3d800f9bf31d30c5bbec5a8…
gatsbybot Nov 14, 2019
65bcd22
sync with monorepo gatsbyjs/gatsby@0cad243ac07e7c813b1f34b33d49893dfd…
gatsbybot Nov 14, 2019
fb139b4
sync with monorepo gatsbyjs/gatsby@75f411db683b7bc65867e9169e8e7c098e…
gatsbybot Nov 14, 2019
5df67e2
sync with monorepo gatsbyjs/gatsby@58a627e86a279fb9d29b88dbc6c3ecaf1e…
gatsbybot Nov 14, 2019
0fd7250
sync with monorepo gatsbyjs/gatsby@21023d5414ab6d606a93ba13ecd7d34574…
gatsbybot Nov 15, 2019
596e3f8
sync with monorepo gatsbyjs/gatsby@70f03f1aa8ede26ce7c89553406fbcb3a6…
gatsbybot Nov 15, 2019
e807630
sync with monorepo gatsbyjs/gatsby@8882caf52cbe451321d9ec489fbab43e46…
gatsbybot Nov 15, 2019
4ae3193
sync with monorepo gatsbyjs/gatsby@037006b0f0f6ea57de121917e864a3cb48…
gatsbybot Nov 15, 2019
d0e309b
sync with monorepo gatsbyjs/gatsby@c369fdd7e0f404ee707c0485910554fb90…
gatsbybot Nov 16, 2019
fee1d87
sync with monorepo gatsbyjs/gatsby@c980634474876f4e36f2dd8626f37b8a9e…
gatsbybot Nov 17, 2019
e2db593
sync with monorepo gatsbyjs/gatsby@aac2b97c427446a4fe632d2558b463cbe6…
gatsbybot Nov 17, 2019
9ed36fb
sync with monorepo gatsbyjs/gatsby@67d8b6be93bb4971dadf6aa8e305af2b53…
gatsbybot Nov 17, 2019
8f84908
sync with monorepo gatsbyjs/gatsby@20afc1b7fbd0e7d722f93f7d345531ce48…
gatsbybot Nov 18, 2019
1c3b9c8
sync with monorepo gatsbyjs/gatsby@26c1b657381e983f0ef36abe228ce8b959…
gatsbybot Nov 19, 2019
307f4c8
sync with monorepo gatsbyjs/gatsby@e1930af756efc530b9e98ab7f344548910…
gatsbybot Nov 19, 2019
a4272be
sync with monorepo gatsbyjs/gatsby@b4b5c32a9cbb77cb435d585efd4c7dea94…
gatsbybot Nov 19, 2019
1b9f88c
sync with monorepo gatsbyjs/gatsby@1cc204540223d2567c984c983aa0894ec8…
gatsbybot Nov 19, 2019
5407445
sync with monorepo gatsbyjs/gatsby@617295a2dac5b65ee10f32407b99089bd5…
gatsbybot Nov 19, 2019
fcb566a
sync with monorepo gatsbyjs/gatsby@ed105ecfb05fb757a3daf667a382301275…
gatsbybot Nov 19, 2019
852fbc8
sync with monorepo gatsbyjs/gatsby@b549007360d5dbcbfa4fbf0b3367847914…
gatsbybot Nov 20, 2019
13d2123
sync with monorepo gatsbyjs/gatsby@328f2e6376f5fc809fd3054551494ec7c3…
gatsbybot Nov 20, 2019
40d2f81
sync with monorepo gatsbyjs/gatsby@ed5f99116650a6f761110e0b19b6721ecb…
gatsbybot Nov 21, 2019
f600ab6
sync with monorepo gatsbyjs/gatsby@a6d9655471b3c45e98d06ba5c6769feca4…
gatsbybot Nov 21, 2019
d0da07d
sync with monorepo gatsbyjs/gatsby@baea43900ee3a99869393a06d9185a8d2c…
gatsbybot Nov 21, 2019
2e7cc9c
sync with monorepo gatsbyjs/gatsby@e81c45cfc4cf595ab21a1536f8dbb91664…
gatsbybot Nov 21, 2019
236d7ec
sync with monorepo gatsbyjs/gatsby@f86d8c68075593d839939404ee2169b633…
gatsbybot Nov 21, 2019
4f39882
sync with monorepo gatsbyjs/gatsby@7f9d5bb413d1a6935543375c23e2ce5e4a…
gatsbybot Nov 24, 2019
8072e57
sync with monorepo gatsbyjs/gatsby@ca4a65c1dc01647f8a514127cd3db6dbb1…
gatsbybot Nov 25, 2019
c10243a
sync with monorepo gatsbyjs/gatsby@613304cf7f0ab27a69ac9f299c92b492d6…
gatsbybot Nov 26, 2019
4be9eb0
sync with monorepo gatsbyjs/gatsby@2a8dd66da1fbf312a78e0a2ac87e52d05e…
gatsbybot Nov 26, 2019
5677b04
sync with monorepo gatsbyjs/gatsby@c120b1e461a4474c12301413b1a272e2a9…
gatsbybot Nov 26, 2019
6b1ccea
sync with monorepo gatsbyjs/gatsby@5dc665f9a0285c159e3bba28afd0dca929…
gatsbybot Nov 27, 2019
84ef4fc
sync with monorepo gatsbyjs/gatsby@c65f112bf2f500558effc8520c8e0e3d51…
gatsbybot Nov 27, 2019
e2d15c2
sync with monorepo gatsbyjs/gatsby@0264f2733d62e67f8342737957431488f4…
gatsbybot Nov 27, 2019
ae922c6
sync with monorepo gatsbyjs/gatsby@2e50fab34d76db1b98682275a186618a19…
gatsbybot Nov 27, 2019
f86f08a
sync with monorepo gatsbyjs/gatsby@e0c16184e434bef7a8c4b3b3d9f636b487…
gatsbybot Nov 27, 2019
0a2cd37
sync with monorepo gatsbyjs/gatsby@7b814f8d2c3b3d7ee0cd8e21d7641c199c…
gatsbybot Nov 28, 2019
8df44f4
sync with monorepo gatsbyjs/gatsby@c125ec2cb2ad13f29106844282cb6f4bdd…
gatsbybot Dec 2, 2019
ccec66e
sync with monorepo gatsbyjs/gatsby@da20db92c4f8d1d75aab55bba66ceb9c75…
gatsbybot Dec 2, 2019
b269207
sync with monorepo gatsbyjs/gatsby@f2bfeda003246acf6f395c4b1580f3cae7…
gatsbybot Dec 2, 2019
356d27d
sync with monorepo gatsbyjs/gatsby@10663d8aab01410417ab62846988e25d70…
gatsbybot Dec 2, 2019
e691de3
sync with monorepo gatsbyjs/gatsby@d81605ba2819e7212274820c438dcde9a4…
gatsbybot Dec 4, 2019
a67cad0
sync with monorepo gatsbyjs/gatsby@ea8147cae1bb0066632351a411cc77e119…
gatsbybot Dec 4, 2019
dafcf64
sync with monorepo gatsbyjs/gatsby@7c34e69f644487f4474a54188d1106077f…
gatsbybot Dec 5, 2019
fd34ed6
sync with monorepo gatsbyjs/gatsby@0c44d22fd47b00f72488d5292646e76ff9…
gatsbybot Dec 5, 2019
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
72 changes: 32 additions & 40 deletions docs/contributing/blog-and-website-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,49 +12,41 @@ Here are some things to keep in mind when deciding where to contribute to Gatsby

## Contributing to the blog

Note: Before adding a blog post, ensure you have approval from a member of the Gatsby team. You should [open an issue](https://github.com/gatsbyjs/gatsby/issues/new/choose) or contact [@gatsbyjs on Twitter](https://twitter.com/gatsbyjs) before opening a PR with your blog post. Check out past blog posts for examples of posted content.

To add a new blog post to the gatsbyjs.org blog:

- Clone [the Gatsby repo](https://github.com/gatsbyjs/gatsby/) and navigate to `/www`.
- Run `yarn` to install all of the website's dependencies. ([Why Yarn?](/contributing/setting-up-your-local-dev-environment#using-yarn))
- Run `npm run develop` to preview the blog at `http://localhost:8000/blog`.
- The content for the blog lives in the `/docs/blog` folder. Make additions or modifications here.
- Add your avatar image to `/docs/blog/avatars`.
- Add your name to `/docs/blog/author.yaml`.
- Add a new folder following the pattern `/docs/blog/yyyy-mm-dd-title`. Within this newly created folder, add an `index.md` file.
- Add `title`, `date`, `author`, `excerpt`, and `tags` to the frontmatter of your `index.md`. You can [view existing tags](/blog/tags/), or [add a new one](https://github.com/gatsbyjs/gatsby/blob/master/www/src/data/tags-docs.js) if you feel your tag merits being its own tag, though we encourage you to use existing tags.
- If you are cross posting your post, you can add `canonicalLink` for SEO benefits. You can check the other blog posts in `/docs/blog` for examples.
- If your blog post contains images, add them to your blog post folder and reference them in your post's `index.md`.
- Ensure any links to gatsbyjs.org are relative links - `/contributing/how-to-contribute/` instead of `https://gatsbyjs.org/contributing/how-to-contribute`.
- Follow the [Style Guide](/contributing/gatsby-style-guide/#word-choice) to make sure you're using the appropriate wording.
- Double check your grammar and capitalize 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`. ([PR example](https://github.com/gatsbyjs/gatsby/commit/9c21394add7906974dcfd22ad5dc1351a99d7ceb#diff-bf544fce773d8a5381f64c37d48d9f12))

### Blog post format

The following format can help you in creating your new blog content. At the top is "frontmatter": a fancy name for metadata in Markdown. The frontmatter for your post should include a title, date, singular author name (for now, we would welcome issues/PRs for this), and one or more tags. Your content will follow after the second set of dashes (`---`).

```md
---
title: "Your Great Blog Post"
date: YYYY-MM-DD
author: Jamie Doe
excerpt: "Here is a helpful excerpt or brief description of this blog post."
tags:
- awesome
- post
---
If you'd like to contribute a post to the Gatsby blog, please review the process and guidelines outlined below and submit your
idea for the post to our [Gatsby blog proposal form](https://airtable.com/shr3449954866i3iF)

### Blog proposal submission process

1. Complete and submit the [Gatsby blog proposal form](https://airtable.com/shr3449954866i3iF).
2. A Gatsby team member will review your proposal and let you know if the proposal has been accepted within the next week or so.
- **If the post is accepted:** A Gatsby team member will work with you on a timeline for submitting and reviewing a draft of your blog post and set a tentative publishing date.
- **If the post is not accepted:** We’ll let you know if there are any alternative offers we can make (e.g. offer to retweet if you publish the piece elsewhere, suggest submitting it as an addition to a Gatsby doc, etc.). We’ll also do our best to explain why your proposal was not accepted and encourage you to revise your proposal based on that feedback and resubmit. Please don’t be discouraged from submitting another post in the future!

If you have any questions about the process or your submission, please email [[email protected]](mailto:[email protected]).

### Content guidelines for submitting a blog post proposal

As a Gatsby community member, you have unique insight into the ins and outs of learning Gatsby, building with Gatsby, and contributing to Gatsby’s open source community. Contributing to the Gatsby blog is a great way to share your experiences and insights. Here are some guidelines for what kind of content is and isn’t a good fit for the Gatsby blog.

Things we’re looking for in Gatsby blog content:

- Information to help others overcome challenges you’ve faced while working with Gatsby
- Stories about how Gatsby helped you overcome different challenges on work and personal projects
- Gatsby case studies
- Showcasing a tool, fix, or other content you or someone else have contributed to Gatsby’s open source community
- Showcasing a tool, fix, or other content someone else has contributed to Gatsby’s open source community
- Clear and thoughtful explanations of technical details or complex concepts related to React, GraphQL, web and application development, open-source contribution, Gatsby core, and other Gatsby-adjacent subject matter
- Guidance and resources for learning React, GraphQL, HTML/CSS, web development, best practices, accessibility, SEO, Gatsby, different tool and CMS integrations, and other Gatsby-adjacent subject matter.
- Other topics that you think would be valuable to people learning about or working with Gatsby

Your next great blog post awaits!
Things we’d like to avoid on the Gatsby blog:

Include images by creating a folder for your post and including
Markdown and image files for easy linking.
- **Docs content.** Some content is better found in the Gatsby docs guides and tutorials, as it can be found in a section for related content and not buried under pages of other paginated blog posts.
- **Promotional content.** Please don’t submit content to the Gatsby blog solely for the purpose of promoting a product, yourself, or link-building.
- **Here’s what you can do instead:** If you have a product or project you want to share on the Gatsby blog, focus on practical information, and make sure there’s a clear relationship with Gatsby or Gatsby-adjacent topics. You could write a step by step guide to using your product with Gatsby. You could write a case study highlighting the direct impact Gatsby had on your awesome project and offer helpful tips for others to recreate your success.
- **Content that doesn’t seem to have a clear benefit for Gatsby users and/or the Gatsby community.** For example, if you’re writing about a use-case or integration that’s extremely niche or unique to specific conditions that are really uncommon outside of your organization, the Gatsby blog might not be the best place for your content. Likewise, if your blog post doesn’t seem to have any direct relationship with Gatsby (or an interesting indirect relationship with Gatsby), then it may be more appropriate for a personal blog or another community blog.

![awesome example](./image.jpg)
```
**Please note** that these are guidelines, not rules. If you think your blog post belongs on the Gatsby blog, we absolutely encourage you to submit it. While we reserve the right to decide what is and isn’t appropriate for the Gatsby blog, we also value and encourage your creativity and your contributions.

## Making changes to the website

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/code-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ Check [Debugging the build process](/docs/debugging-the-build-process/) page to

## Feedback

At any point during the contributing process, the Gatsby Core team would love to help! We hold a weekly [Core Maintainer's meeting](/contributing/community#core-maintainers-meeting) where you can share your creation(s) and receive advice and feedback directly from the team!
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.
2 changes: 1 addition & 1 deletion docs/contributing/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Examples of unacceptable behavior by participants include:

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this code of conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this code of conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, divisive, threatening, offensive, or harmful.

## Scope

Expand Down
8 changes: 0 additions & 8 deletions docs/contributing/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,6 @@ Sign up for the Gatsby newsletter to keep up with the latest from the Gatsby com
For the latest news about Gatsby,
[follow **@gatsbyjs** on Twitter](https://twitter.com/gatsbyjs).

### Community Maintainers Meeting

The Gatsby Core team (official Gatsby employees who are working on Gatsby open-source) holds a weekly meeting where we encourage community members to share their projects, struggles, and successes directly with the Gatsby Core team. Additionally the Core team shares pertinent info and plans that are applicable to the community!

This event is held on a recurring basis, every Wednesday at 8:30 AM Pacific Standard Time (PST).

[Add the recurring calendar invite here](https://gatsby.dev/core-maintainers)

## Where to get support

### Stack Overflow
Expand Down
7 changes: 7 additions & 0 deletions docs/contributing/docs-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,13 @@ After going through the [development setup instructions](/contributing/setting-u
- View the changes in your browser at `http://localhost:8000`.
- Commit your changes and [submit a pull request](/contributing/how-to-open-a-pull-request/)!

## Changing headers

It can be necessary to change a heading within the docs. It's important to note that headers automatically generate links with a corresponding URL that can be deep-linked from elsewhere on the site. When changing a header, be sure to point all corresponding links to the new URL. Here are some workflow tips:

- Determine the URL you're looking for. `Changing headers` is linked with a URL ending in `changing-headers`, `Docs renaming instructions` becomes `docs-renaming-instructions`, etc.
- Update all instances of the old URL to your new one. [Find and replace](https://code.visualstudio.com/docs/editor/codebasics#_search-across-files) in VS Code can help. Check that the context of the original link reference still makes sense with the new one.

## Docs renaming instructions

Sometimes it makes sense to move or rename a file as part of docs restructuring or for content clarification. While we recommend keeping URLs consistent as often as possible, here are some tips to minimize errors and keep the docs in a good state:
Expand Down
5 changes: 5 additions & 0 deletions docs/contributing/gatsby-docs-translation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,21 @@ The first step for starting a new translation is to check what exists. So far, t
- [Arabic](https://github.com/gatsbyjs/gatsby-ar)
- [German](https://github.com/gatsbyjs/gatsby-de)
- [Spanish](https://github.com/gatsbyjs/gatsby-es)
- [French](https://github.com/gatsbyjs/gatsby-fr)
- [Gujarati](https://github.com/gatsbyjs/gatsby-gu)
- [Hindi](https://github.com/gatsbyjs/gatsby-hi)
- [Indonesian](https://github.com/gatsbyjs/gatsby-id)
- [Italian](https://github.com/gatsbyjs/gatsby-it)
- [Korean](https://github.com/gatsbyjs/gatsby-ko)
- [Mongolian](https://github.com/gatsbyjs/gatsby-mn)
- [Dutch](https://github.com/gatsbyjs/gatsby-nl)
- [Polish](https://github.com/gatsbyjs/gatsby-pl)
- [Brazilian Portuguese](https://github.com/gatsbyjs/gatsby-pt-BR)
- [Russian](https://github.com/gatsbyjs/gatsby-ru)
- [Turkish](https://github.com/gatsbyjs/gatsby-tr)
- [Vietnamese](https://github.com/gatsbyjs/gatsby-vi)
- [Simplified Chinese](https://github.com/gatsbyjs/gatsby-zh-Hans)
- [Traditional Chinese](https://github.com/gatsbyjs/gatsby-zh-Hant)

> Note: Once a new translation repository is created, feel free to add it here in a PR!

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/gatsby-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ For words that have multiple spellings, prefer the US English word over British

### Use apps that help you edit

Use the [Hemingway App](https://www.hemingwayapp.com/). There’s nothing magical
Use the [Hemingway App](https://hemingwayapp.com/). There’s nothing magical
about this tool, but it will automatically detect widely agreed-upon
style issues:

Expand Down
35 changes: 32 additions & 3 deletions docs/contributing/setting-up-your-local-dev-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,58 @@ Yarn is a package manager for your code, similar to [NPM](https://www.npmjs.com/

## Gatsby repo install instructions

### Install Node and Yarn

- Ensure you have the latest **LTS** version of Node installed (>= 10.16.0). `node --version`
- [Install](https://yarnpkg.com/en/docs/install) the Yarn package manager.
- Ensure you have the latest version of Yarn installed (>= 1.0.2). `yarn --version`
- Fork the [official repository](https://github.com/gatsbyjs/gatsby).

### Fork, clone, and branch the repository

- [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [official `gatsbyjs/gatsby` repository](https://github.com/gatsbyjs/gatsby).
- Clone your fork: `git clone --depth=1 https://github.com/<your-username>/gatsby.git`
- 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`.
- Install [gatsby-dev-cli](https://www.npmjs.com/package/gatsby-dev-cli) globally: `yarn global add gatsby-dev-cli`

### Gatsby functional changes

- Install [gatsby-cli](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-cli):
- Make sure you have the Gatsby CLI installed with `gatsby -v`,
- if not, install globally: `yarn global add gatsby-cli`
- Install [gatsby-dev-cli](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-dev-cli):
- Make sure you have the Gatsby Dev CLI installed with `gatsby-dev -h`
- if not, install globally: `yarn global add gatsby-dev-cli`
- Run `yarn install` in each of the sites you're testing.
- Make sure you have the Gatsby CLI installed with `gatsby -v`, if not run `yarn global add gatsby-cli`
- For each of your Gatsby test sites, run the `gatsby-dev` command inside the test site's directory to copy
the built files from your cloned copy of Gatsby. It'll watch for your changes
to Gatsby packages and copy them into the site. For more detailed instructions
see the [gatsby-dev-cli README](https://www.npmjs.com/package/gatsby-dev-cli) and check out the [gatsby-dev-cli demo video](https://www.youtube.com/watch?v=D0SwX1MSuas).

- Note: if you plan to modify packages that are exported from `gatsby` directly, you need to either add those manually to your test sites so that they are listed in `package.json` (e.g. `yarn add gatsby-link`), or specify them explicitly with `gatsby-dev --packages gatsby-link`).

### Add tests

- Add tests and code for your changes.
- Once you're done, make sure all tests still pass: `yarn test`.

- To run tests for a single package you can run: `yarn jest <package-name>`.
- To run a single test file you can run: `yarn jest <file-path>`.

### Commits and pull requests

- Commit and push to your fork.
- Create a pull request from your branch.

### 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)
73 changes: 0 additions & 73 deletions docs/contributing/submit-to-creator-showcase.md

This file was deleted.

Loading