How to contribute

Writing blog posts

Check out the instructions here.

Developing the website

1. Claim an issue.
2. You can either do your work on Codespaces, or locally.

• If using Codespaces, open a Codespace, wait for the script to run, and then run npm run develop. This spins up a "local" version of the website at some URL generated by GitHub.
• If locally, you will need to install Node.js, and npm.

3. When you are done with your issue:
   1. Make a new branch with your name and the issue number. For instance, "lucy-4".
   2. Commit your changes with a message mentioning your issue number such as "done #4", please include the # because GitHub will automatically link that commit to the issue. Push you changes to that branch and open a PR. You are responsible for dealing with any merge conflicts. If your PR has merge conflicts I will not review it.
   3. If your changes are approved, I'll merge your branch into the master branch.

If you claim and issue and have not worked on it for 2 weeks, I'll check in. If you can't complete the issue I will unassign you.

Most issues are related to this Figma. Ask Lucy for clarifying questions.

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a typical Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package.json
└── README.md

1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

4. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

5. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

6. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

7. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

8. LICENSE: This Gatsby starter is licensed under the 0BSD license. This means that you can see this file as a placeholder and replace it with your own license.

9. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

10. README.md: A text file containing useful reference information about your project.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

• For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

• To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.