Page MenuHomeElementl

[Documentation] Refresh the Contributing guides
ClosedPublic

Authored by yichendai on Jan 15 2021, 3:22 AM.

Details

Summary

Add the details of our PR process and give community members a better picture.

Depends on D5651

Next step: Will mention about our Swag Store at the end once it goes online in February.

Test Plan

Run localhost 3001

Diff Detail

Repository
R1 dagster
Branch
contribute
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

Left a couple of comments!

docs/next/src/pages/community/contributing.mdx
10
137

just to highlight it

141

it's weird how this is kebab case (looks like it is kebab case in our issues board). Consider standardizing it to "good second issue", like "good first issue"?

143–144

fixed typo, and added link to issues sorted by emojis

148–149

inline links, and added oxford comma

150

Since you used the acronym PR below, it's useful to define first from its origin (i.e. Pull Request), before referencing it later on

153
158
160
yichendai added inline comments.
docs/next/src/pages/community/contributing.mdx
137

I had trouble running docs site locally for some reason ☹️. Will review the whole page again tomorrow and revise it.

141

Yes! this also reminds me of fixing the label in github

161

After reconsidering, I think we should mention the Swag store after it goes online.

yichendai retitled this revision from Refresh contributing guides to [Documentation] Refresh the Contributing guides.Jan 15 2021, 8:48 PM
yichendai edited the summary of this revision. (Show Details)
yichendai added reviewers: catherinewu, yuhan.
docs/next/src/pages/community/contributing.mdx
10

Prefer present tense: "We love to our community members get involved!"

134

Suggest: "Picking a Github Issue"

136

"an issue"

145

Since there are not that many issues with 👍 emoji currently (and many are hard), I think we can also suggest that contributors can also explore the other labels and pick an issue based on their interests?

docs/next/src/pages/community/contributing.mdx
145

I notice quite a few PRs are related to the integration and libraries. What kind of labels do we want to encourage users to work on?

yichendai added inline comments.
docs/next/src/pages/community/contributing.mdx
145

Change to:

When you are ready for more of a challenge, you can tackle issues with the
most 👍 reactions. You can also explore other labels and pick any issue based on your interest.

docs/next/src/pages/community/contributing.mdx
138

"in the" -> "on the"

162

remove "for"

docs/next/src/pages/community/contributing.mdx
148
155

In the PR template, please describe the change, including the motivation/context, test coverage, and any other relevant information. Please note if the PR is a breaking change or if it is related to an open GitHub issue.

yichendai added inline comments.
docs/next/src/pages/community/contributing.mdx
147

resigning as the adoption folks have more context to sign off the copy :)

This revision is now accepted and ready to land.Jan 23 2021, 2:57 AM