Skip to content
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

Docs: Move CONTRIBUTING.md to docs/ #36167

Merged
merged 1 commit into from
Mar 13, 2020
Merged

Conversation

ockham
Copy link
Contributor

@ockham ockham commented Sep 15, 2019

Changes proposed in this Pull Request

  • Docs: Move CONTRIBUTING.md from .github/ to docs/

The motivation for this is #35833 -- to enable webpack loaders to find this file (in a non-hidden directory).

GitHub should continue to be able to find this file:

To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, docs, or .github folder. When someone opens a pull request or creates an issue, they will see a link to that file.

(Source)

Testing instructions

  • Go to calypso.localhost:3000/devdocs, and click on "Contributing" in the sidebar. Verify that the link still works.
  • Grep the codebase to verify there are no other references to .github/CONTRIBUTING.md.

@ockham ockham added Documentation [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. DevDocs labels Sep 15, 2019
@ockham ockham requested review from sirreal and a team September 15, 2019 22:42
@ockham ockham self-assigned this Sep 15, 2019
@matticbot
Copy link
Contributor

@matticbot
Copy link
Contributor

matticbot commented Sep 15, 2019

Here is how your PR affects size of JS and CSS bundles shipped to the user's browser:

Sections (~3 bytes removed 📉 [gzipped])

name     parsed_size           gzip_size
devdocs        -12 B  (-0.0%)       -3 B  (-0.0%)

Sections contain code specific for a given set of routes. Is downloaded and parsed only when a particular route is navigated to.

Legend

What is parsed and gzip size?

Parsed Size: Uncompressed size of the JS and CSS files. This much code needs to be parsed and stored in memory.
Gzip Size: Compressed size of the JS and CSS files. This much data needs to be downloaded over network.

Generated by performance advisor bot at iscalypsofastyet.com.

@ockham ockham force-pushed the move/contributing-md-to-docs branch from 1dd8cb6 to 8e3fd6b Compare October 10, 2019 05:31
@ockham ockham force-pushed the move/contributing-md-to-docs branch from 8e3fd6b to bf05135 Compare January 10, 2020 23:51
@lancewillett
Copy link
Contributor

Any objections or gotchas, @Automattic/team-calypso? Looks sane to me.

@tyxla
Copy link
Member

tyxla commented Mar 13, 2020

Needs a rebase, but other than that LGTM 👍

Will take over to land it, as Bernie is AFK these days.

@tyxla tyxla force-pushed the move/contributing-md-to-docs branch from bf05135 to 5cc6c62 Compare March 13, 2020 13:36
Copy link
Member

@tyxla tyxla left a comment

Choose a reason for hiding this comment

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

This LGTM, thanks! Going to 🚢 it.

@tyxla tyxla added [Status] Ready to Merge and removed [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. labels Mar 13, 2020
@tyxla tyxla merged commit 1569b58 into master Mar 13, 2020
@tyxla tyxla deleted the move/contributing-md-to-docs branch March 13, 2020 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants