Skip to main content

Blog & Website Contributions

We wholeheartedly welcome contributions to the Gatsby blog and website!

Here are some things to keep in mind when deciding where to contribute to Gatsby:

  • Blog posts work best for case studies and time-sensitive storytelling (see the blog post format).
  • Docs are continually relevant and discoverable learning materials that go beyond any one case study or situation.
  • Website changes that improve either of these are always welcome!

Contributing to the blog

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

Blog proposal submission process

  1. Complete and submit the Gatsby blog proposal form.
  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 marketing@gatsbyjs.com.

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

Things we’d like to avoid on the Gatsby blog:

  • 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.

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

If you want to make changes, improvements, or add new functionality to the website, you don’t have to set up the full Gatsby repo to contribute. You can spin up your own instance of the Gatsby website with these steps:

  • Clone the Gatsby repo and navigate to /www
  • Run yarn to install all of the website’s dependencies.
  • Run npm run develop to preview the site at http://localhost:8000/.

Note: If you are experiencing issues on a Linux machine, run sudo apt install libvips-dev, to install a native dependency. You can also reference Gatsby guide on Linux for other Linux-specific requirements.

Now you can make and preview your changes before raising a pull request!

For full repo setup instructions, visit the code contributions page.


Edit this page on GitHub
Docs
Tutorials
Plugins
Blog
Showcase