Skip to content

misc: update CONTRIBUTING to reflect status quo #5989

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

Merged
merged 3 commits into from
Nov 27, 2021
Merged

Conversation

Josh-Cena
Copy link
Collaborator

Motivation

The CONTRIBUTING is quite old, made some updates & cleanups. Also removed the legacy extending-remarkable writeup from v1.

Have you read the Contributing Guidelines on pull requests?

Yes

Verified

This commit was signed with the committer’s verified signature.
Josh-Cena Joshua Chen
@Josh-Cena Josh-Cena added the pr: maintenance This PR does not produce any behavior differences to end users when upgrading. label Nov 22, 2021
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Nov 22, 2021
@Josh-Cena Josh-Cena added pr: documentation This PR works on the website or other text documents in the repo. and removed pr: maintenance This PR does not produce any behavior differences to end users when upgrading. labels Nov 22, 2021
CONTRIBUTING.md Outdated
@@ -170,6 +169,10 @@ Copy and paste this to the top of your new file(s):

In order to accept your pull request, we need you to submit a CLA. You only need to do this once, so if you've done this for another Facebook open source project, you're good to go. If you are submitting a pull request for the first time, the Facebook GitHub Bot will reply with a link to the CLA form. You may also [complete your CLA here](https://code.facebook.com/cla).

After you have signed the CLA, the CLA bot would automatically update the PR status. There's no need to open a new PR.

**CLAs are required for us to merge your pull request.** While we value your effort and are willing to wait for you to come back and address the reviews in case you are unavailable sending the pull request, pull requests that are ready to merge but have CLA missing and no response from the author **will be closed within two weeks of opening**. If you have further questions, please stay in touch with us.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to formalize this: we would close PRs without CLA within two weeks. It's better than waiting forever on a PR that can't be merged.

Verified

This commit was signed with the committer’s verified signature.
Josh-Cena Joshua Chen
@netlify
Copy link

netlify bot commented Nov 22, 2021

✔️ [V2]

🔨 Explore the source changes: 04eccaa

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/619ba61af885a700083f8559

😎 Browse the preview: https://deploy-preview-5989--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Nov 22, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 76
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-5989--docusaurus-2.netlify.app/

@github-actions
Copy link

github-actions bot commented Nov 22, 2021

Size Change: +47 B (0%)

Total Size: 892 kB

Filename Size Change
website/build/assets/css/styles.********.css 100 kB +48 B (0%)
ℹ️ View Unchanged
Filename Size Change
website/.docusaurus/globalData.json 38.3 kB 0 B
website/build/assets/js/main.********.js 477 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 66.2 kB 0 B
website/build/blog/index.html 37.8 kB 0 B
website/build/docs/index.html 44 kB +1 B (0%)
website/build/docs/installation/index.html 51.7 kB -2 B (0%)
website/build/index.html 29.5 kB 0 B
website/build/tests/docs/index.html 25.2 kB 0 B
website/build/tests/docs/standalone/index.html 21.7 kB 0 B

compressed-size-action

@netlify

This comment has been minimized.

@Josh-Cena Josh-Cena merged commit 0e6ec24 into main Nov 27, 2021
@Josh-Cena Josh-Cena deleted the jc/update-contributing branch November 27, 2021 08:24
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for that 👍

There's another place where we have similar text that should probably be kept in sync (still has a ref to CircleCI for example)

https://docusaurus.io/community/contributing

Maybe there are some sections that can be shared thanks to MDX? 🤷‍♂️


## Example
The various types of commits:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

worth mentioning that it's mostly for maintainers when squashing commits, we don't care too much about internal PR commits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants