Skip to content

Commit

Permalink
Add blog post introducing RFC process (#4876)
Browse files Browse the repository at this point in the history
* Add blog post introducing RFC process

* Small fixes

* Add links to contributing docs to RFC blog post

* Add date
  • Loading branch information
KyleAMathews authored Apr 6, 2018
1 parent fa10362 commit 9d989bf
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 3 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ title: How to Contribute
We want contributing to Gatsby to be fun, enjoyable, and educational for anyone and everyone. Contributions go far beyond pull requests and commits; we are thrilled to receive a variety of other contributions including the following:

* Blogging, speaking about, or creating tutorials about one of Gatsby's many features. Mention @gatsbyjs on Twitter and/or email shannon [at] gatsbyjs [dot] com so we can give pointers and tips (if you want them :) and help you spread the word. Please add your blog posts and videos of talks to our [Awesome Gatsby](/docs/awesome-gatsby/) page.
* [Submit new feature ideas through an RFC](/blog/2018-04-06-introducing-gatsby-rfc-process/)
* Submitting new documentation; titles in _italics_ on gatsbyjs.org are stubs and need contributions
* Tweeting about things you build with @gatsbyjs (make sure to @ mention us!)
* Submitting documentation updates, enhancements, designs, or bugfixes
Expand Down
33 changes: 33 additions & 0 deletions docs/blog/2018-04-06-introducing-gatsby-rfc-process/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: "Introducing the Gatsby RFC Process"
author: Kyle Mathews
date: "2018-04-06"
---

We're adopting an RFC ("request for comments") process for contributing ideas to Gatsby.

Inspired by [React](https://github.com/reactjs/rfcs), [Yarn](https://github.com/yarnpkg/rfcs), [Ember](https://github.com/emberjs/rfcs), and [Rust](https://github.com/rust-lang/rfcs), the goal is to allow Gatsby core team members and community members to collaborate on the design of new features. It's also intended to provide a clear path for ideas to enter the project:

- Create an RFC document detailing your proposal.
- Submit a PR to the [RFC repository](https://github.com/gatsbyjs/rfcs).
- Incorporate feedback into the proposal.
- After discussion, the core team may or may not accept the RFC.
- If the RFC is accepted, the PR is merged.

RFCs are accepted when they are approved for implementation in Gatsby. A more thorough description of the process is available in the repository's [README](https://github.com/gatsbyjs/rfcs/blob/master/README.md). The exact details may be refined in the future.

## Who Can Submit RFCs?

Anyone! No knowledge of Gatsby's internals is required, nor are you expected to implement the proposal yourself.

## What Types of Changes Should Be Submitted As RFCs?

Generally, any idea that would benefit from additional review or design before being implemented is a good candidate for an RFC. As a rule of thumb, this means any proposal that adds, changes, or removes a Gatsby API.

Not every change must go through the RFC process. Bug fixes or performance improvements that don't touch the API can be submitted directly to the main library.

## RFCs for a new GitHub labeling system and to remove our special layout component

Coinciding with the launch of our RFC process, we've submitted a [proposal for a new GitHub labeling system](https://github.com/gatsbyjs/rfcs/pull/1) and a [proposal to remove our special layout component](https://github.com/gatsbyjs/rfcs/pull/2). Both proposals have already received many valuable comments from the community that we're incorporating into the design of the new process and API.

Both PRs are good examples of how a typical RFC should be structured. We're excited to start receiving your proposals!
1 change: 1 addition & 0 deletions docs/docs/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The Gatsby community welcomes contributions. Please refer to the guides below on

* [How to Contribute](/docs/how-to-contribute/)
* [How to File an Issue](/docs/how-to-file-an-issue/)
* [Make feature requests with an RFC](/blog/2018-04-06-introducing-gatsby-rfc-process/)
* [Gatsby Style Guide](/docs/gatsby-style-guide/)

## Gatsby news
Expand Down
11 changes: 8 additions & 3 deletions www/src/templates/template-blog-post.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,18 @@ class BlogPostTemplate extends React.Component {
</p>
)
let canonicalLink
if(post.frontmatter.canonicalLink) {
canonicalLink = <link rel="canonical" href={post.frontmatter.canonicalLink} />
if (post.frontmatter.canonicalLink) {
canonicalLink = (
<link rel="canonical" href={post.frontmatter.canonicalLink} />
)
}

return (
<div>
<Container className="post" css={{ paddingBottom: `0 !important` }}>
<Container
className="post"
css={{ paddingTop: rhythm(3), paddingBottom: `0 !important` }}
>
{/* Add long list of social meta tags */}
<Helmet>
<title>{post.frontmatter.title}</title>
Expand Down

0 comments on commit 9d989bf

Please sign in to comment.