diff --git a/packages/README.md b/packages/README.md index e9e5abf5ea7b1..22dad99b9b757 100644 --- a/packages/README.md +++ b/packages/README.md @@ -46,6 +46,7 @@ When creating a new package, you need to provide at least the following: - Installation details - Usage example - API documentation, if applicable ([more info](#maintaining-api-documentation)) + - A link to the contributing guidelines ([here's an example](https://github.com/WordPress/gutenberg/tree/HEAD/packages/a11y/README.md#contributing-to-this-package) from the a11y package) - `Code is Poetry` logo (`

Code is Poetry.

`) 4. `CHANGELOG.md` file containing at least: diff --git a/packages/a11y/README.md b/packages/a11y/README.md index 7e5261adaae16..14c497c1abb53 100644 --- a/packages/a11y/README.md +++ b/packages/a11y/README.md @@ -70,4 +70,10 @@ For context I’ll quote [this article on WordPress.org](https://make.wordpress. See +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). +

Code is Poetry.

diff --git a/packages/admin-manifest/README.md b/packages/admin-manifest/README.md index 6b6ac3021fe30..8878e9d77aef1 100644 --- a/packages/admin-manifest/README.md +++ b/packages/admin-manifest/README.md @@ -1,3 +1,11 @@ # Admin Manifest Dynamically creates a Web App [manifest](https://w3c.github.io/manifest/) and registers the service worker for the admin. + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/annotations/README.md b/packages/annotations/README.md index 96233b9a7c12c..2cdb0913daf2b 100644 --- a/packages/annotations/README.md +++ b/packages/annotations/README.md @@ -19,3 +19,11 @@ You need to include `wp-annotations` as a dependency of the JavaScript file in w ## Usage [See this page for more detailed usage instructions](https://developer.wordpress.org/block-editor/developers/block-api/block-annotations). + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/api-fetch/README.md b/packages/api-fetch/README.md index 055cd1a036883..ae7b1a500aa4f 100644 --- a/packages/api-fetch/README.md +++ b/packages/api-fetch/README.md @@ -148,4 +148,10 @@ apiFetch.setFetchHandler( ( options ) => { } ); ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/autop/README.md b/packages/autop/README.md index 1e5d75e20b15f..76a7515db69f3 100644 --- a/packages/autop/README.md +++ b/packages/autop/README.md @@ -64,4 +64,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/babel-plugin-import-jsx-pragma/README.md b/packages/babel-plugin-import-jsx-pragma/README.md index eb88d86ec1131..fae0f49d6596c 100644 --- a/packages/babel-plugin-import-jsx-pragma/README.md +++ b/packages/babel-plugin-import-jsx-pragma/README.md @@ -90,4 +90,10 @@ _Type:_ Boolean Whether the scopeVariable is the default import of the source module. Note that this has no impact on `scopeVariableFrag`. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/babel-plugin-makepot/README.md b/packages/babel-plugin-makepot/README.md index 7e0f903476940..c7e14cbb1c2ad 100644 --- a/packages/babel-plugin-makepot/README.md +++ b/packages/babel-plugin-makepot/README.md @@ -23,4 +23,10 @@ npm install @wordpress/babel-plugin-makepot --save-dev **Note**: This package requires Node.js 12.0.0 or later. It is not compatible with older versions. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/babel-preset-default/README.md b/packages/babel-preset-default/README.md index 0f6355b334f62..3bff3e2df8d81 100644 --- a/packages/babel-preset-default/README.md +++ b/packages/babel-preset-default/README.md @@ -49,4 +49,10 @@ This needs to be included before all your compiled Babel code. You can either pr If you need to use a proposal that is not Stage 4, this polyfill will not automatically import those for you. You will have to import those from another polyfill like [`core-js`](https://github.com/zloirock/core-js) individually. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/base-styles/README.md b/packages/base-styles/README.md index 836196bb5ec45..9c57d91ac5a98 100644 --- a/packages/base-styles/README.md +++ b/packages/base-styles/README.md @@ -40,4 +40,10 @@ To make that work with [`sass`](https://www.npmjs.com/package/sass) or [`node-sa } ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/blob/README.md b/packages/blob/README.md index 2ae25831b3846..cfa7b745a595c 100644 --- a/packages/blob/README.md +++ b/packages/blob/README.md @@ -76,4 +76,10 @@ _Parameters_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/block-directory/README.md b/packages/block-directory/README.md index d17aae691f767..7cb81993d837f 100644 --- a/packages/block-directory/README.md +++ b/packages/block-directory/README.md @@ -253,4 +253,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/block-editor/README.md b/packages/block-editor/README.md index 55eaf01f744cd..16a23a0d7c506 100644 --- a/packages/block-editor/README.md +++ b/packages/block-editor/README.md @@ -823,4 +823,10 @@ _Parameters_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/block-library/README.md b/packages/block-library/README.md index ba9f3d954b492..e6dedab175aa4 100644 --- a/packages/block-library/README.md +++ b/packages/block-library/README.md @@ -90,4 +90,10 @@ _Parameters_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/block-serialization-default-parser/README.md b/packages/block-serialization-default-parser/README.md index aedbed8d95244..760ab208955c1 100644 --- a/packages/block-serialization-default-parser/README.md +++ b/packages/block-serialization-default-parser/README.md @@ -151,4 +151,10 @@ Further, tokenizing with a RegExp brings an additional advantage. The parser gen However, since our "token language" of the block comment delimiters is _regular_ and _can_ be trivially matched with RegExp patterns, we can do that here and then something magical happens: we jump out of PHP or JavaScript and into a highly-optimized RegExp engine written in C or C++ on the host system. We thereby leave the virtual machine and its overhead. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/block-serialization-spec-parser/README.md b/packages/block-serialization-spec-parser/README.md index 412746673220f..763ba6046b87f 100644 --- a/packages/block-serialization-spec-parser/README.md +++ b/packages/block-serialization-spec-parser/README.md @@ -24,4 +24,10 @@ parse( '' ); // [{"attrs": null, "blockName": "core/more", "innerBlocks": [], "innerHTML": ""}] ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/blocks/README.md b/packages/blocks/README.md index 295cb258962ef..7b77d1f96b830 100644 --- a/packages/blocks/README.md +++ b/packages/blocks/README.md @@ -868,4 +868,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/browserslist-config/README.md b/packages/browserslist-config/README.md index c46fcbe88cc8d..f6fb1be952efd 100644 --- a/packages/browserslist-config/README.md +++ b/packages/browserslist-config/README.md @@ -30,4 +30,10 @@ extends @wordpress/browserslist-config This package when imported returns an array of supported browsers, for more configuration examples including Autoprefixer, Babel, ESLint, PostCSS, and stylelint see the [Browserslist examples](https://github.com/ai/browserslist-example#browserslist-example) repo. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/components/README.md b/packages/components/README.md index 960cd017adcca..ebc5f52238bb6 100644 --- a/packages/components/README.md +++ b/packages/components/README.md @@ -37,6 +37,12 @@ In non-WordPress projects, link to the `build-style/style.css` file directly, it You can browse the components docs and examples at https://wordpress.github.io/gutenberg/ -## Contributing +## Contributing to this package -See [CONTRIBUTING.md](/packages/components/CONTRIBUTING.md) for the contributing guidelines for the `@wordpress/components` package. +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +This package also has its own [contributing information](/packages/components/CONTRIBUTING.md) where you can find additional details. + +

Code is Poetry.

diff --git a/packages/compose/README.md b/packages/compose/README.md index 57be6249dcab4..7364379b0d32f 100644 --- a/packages/compose/README.md +++ b/packages/compose/README.md @@ -546,4 +546,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/core-data/README.md b/packages/core-data/README.md index 4af8bc12debe2..eeead7b6a7efd 100644 --- a/packages/core-data/README.md +++ b/packages/core-data/README.md @@ -761,4 +761,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/create-block-tutorial-template/README.md b/packages/create-block-tutorial-template/README.md index fc3dbdd378bee..47cce228e397d 100644 --- a/packages/create-block-tutorial-template/README.md +++ b/packages/create-block-tutorial-template/README.md @@ -10,4 +10,10 @@ This block template can be used by running the following command: npx @wordpress/create-block --template @wordpress/create-block-tutorial-template ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/create-block/README.md b/packages/create-block/README.md index 1e56c1f65fb84..cec97aa1eec2b 100644 --- a/packages/create-block/README.md +++ b/packages/create-block/README.md @@ -213,4 +213,10 @@ The following configurable variables are used with the template files. Template - `editorStyle` (default: `'file:./build/index.css'`) - `style` (default: `'file:./build/style-index.css'`) -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/custom-templated-path-webpack-plugin/README.md b/packages/custom-templated-path-webpack-plugin/README.md index 0ca5d20665851..05e8f70c62da1 100644 --- a/packages/custom-templated-path-webpack-plugin/README.md +++ b/packages/custom-templated-path-webpack-plugin/README.md @@ -60,4 +60,10 @@ module.exports = { For more examples, refer to Webpack's own [`TemplatedPathPlugin.js`](https://github.com/webpack/webpack/blob/v4.1.1/lib/TemplatedPathPlugin.js), which implements the base set of template tags. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/customize-widgets/README.md b/packages/customize-widgets/README.md index d5fb6b36f5a93..796fa54950cc6 100644 --- a/packages/customize-widgets/README.md +++ b/packages/customize-widgets/README.md @@ -30,4 +30,10 @@ For React developers, this can be thought of as a custom reconciler or a custom This is not the typical way the block editor is intended to be used. As a result, we have to also implement some missing features such as undo/redo and custom focus control. It is still a goal to make the block editor as easy to integrate into different systems as possible, so the integration in the Widgets Customizer can be a good experience for us to reflect some drawbacks in our current API and potentially improve them in the future. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/data-controls/README.md b/packages/data-controls/README.md index ba7f4679a6c4b..1482a2840529c 100644 --- a/packages/data-controls/README.md +++ b/packages/data-controls/README.md @@ -104,3 +104,11 @@ _Parameters_ - _args_ `Array`: Arguments passed without change to the `@wordpress/data` control. + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/data/README.md b/packages/data/README.md index 763ce616ede34..6917e2c3a8697 100644 --- a/packages/data/README.md +++ b/packages/data/README.md @@ -1006,4 +1006,10 @@ function Component() { - [What is WordPress Data?](https://unfoldingneurons.com/2020/what-is-wordpress-data/) -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/date/README.md b/packages/date/README.md index f71e2a54b199a..89839bcffa036 100644 --- a/packages/date/README.md +++ b/packages/date/README.md @@ -131,4 +131,10 @@ _Parameters_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/dependency-extraction-webpack-plugin/README.md b/packages/dependency-extraction-webpack-plugin/README.md index a6c78571df810..35cf69b26914c 100644 --- a/packages/dependency-extraction-webpack-plugin/README.md +++ b/packages/dependency-extraction-webpack-plugin/README.md @@ -109,8 +109,8 @@ The output format for the generated asset file. There are two options available: ##### `outputFilename` -- Type: string | function -- Default: null +- Type: string | function +- Default: null The filename for the generated asset file. Accepts the same values as the Webpack `output.filename` option. @@ -233,4 +233,10 @@ $script_url = plugins_url( $script_path, __FILE__ ); wp_enqueue_script( 'script', $script_url, $script_asset['dependencies'], $script_asset['version'] ); ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/deprecated/README.md b/packages/deprecated/README.md index f259e4e48afe8..af92d7ed91bb6 100644 --- a/packages/deprecated/README.md +++ b/packages/deprecated/README.md @@ -78,4 +78,10 @@ _Type_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/docgen/README.md b/packages/docgen/README.md index aeee10c599363..8787a54b089c0 100644 --- a/packages/docgen/README.md +++ b/packages/docgen/README.md @@ -293,3 +293,11 @@ Adds two numbers. `number` The result of adding the two numbers. ``` + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/dom-ready/README.md b/packages/dom-ready/README.md index 9b9f04cd363b1..6b9ea8ea5ab20 100644 --- a/packages/dom-ready/README.md +++ b/packages/dom-ready/README.md @@ -44,4 +44,10 @@ _Returns_ See -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/dom/README.md b/packages/dom/README.md index 0e64518845bd1..a8ec7ed26547a 100644 --- a/packages/dom/README.md +++ b/packages/dom/README.md @@ -382,4 +382,10 @@ _Parameters_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/e2e-test-utils/README.md b/packages/e2e-test-utils/README.md index 5512371467a65..8c4073df8bdb9 100644 --- a/packages/e2e-test-utils/README.md +++ b/packages/e2e-test-utils/README.md @@ -830,4 +830,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/e2e-tests/README.md b/packages/e2e-tests/README.md index 96996b9222f1b..3024112381e8c 100644 --- a/packages/e2e-tests/README.md +++ b/packages/e2e-tests/README.md @@ -18,31 +18,38 @@ The following commands are available on the Gutenberg repo: { "test-e2e": "wp-scripts test-e2e --config packages/e2e-tests/jest.config.js", "test-e2e:debug": "wp-scripts --inspect-brk test-e2e --config packages/e2e-tests/jest.config.js --puppeteer-devtools", - "test-e2e:watch": "npm run test-e2e -- --watch", + "test-e2e:watch": "npm run test-e2e -- --watch" } ``` ### Run all available tests + ```bash npm run test-e2e ``` + ### Run all available tests and listen for changes. + ```bash npm run test-e2e:watch ``` ### Run a specific test file + ```bash npm run test-e2e -- packages/e2e-test/ # Or, in order to watch for changes: npm run test-e2e:watch -- packages/e2e-test/ ``` + ### Debugging Makes e2e tests available to debug in a Chrome Browser. + ```bash npm run test-e2e:debug ``` + After running the command, tests will be available for debugging in Chrome by going to chrome://inspect/#devices and clicking `inspect` under the path to `/test-e2e.js`. #### Debugging in `vscode` @@ -51,27 +58,32 @@ Debugging in a Chrome browser can be replaced with `vscode`'s debugger by adding ```json { - "type": "node", - "request": "launch", - "name": "Debug current e2e test", - "program": "${workspaceFolder}/node_modules/@wordpress/scripts/bin/wp-scripts.js", - "args": [ - "test-e2e", - "--config=${workspaceFolder}/packages/e2e-tests/jest.config.js", - "--verbose=true", - "--runInBand", - "--watch", - "${file}" - ], - "console": "integratedTerminal", - "internalConsoleOptions": "neverOpen", - "trace": "all" - } + "type": "node", + "request": "launch", + "name": "Debug current e2e test", + "program": "${workspaceFolder}/node_modules/@wordpress/scripts/bin/wp-scripts.js", + "args": [ + "test-e2e", + "--config=${workspaceFolder}/packages/e2e-tests/jest.config.js", + "--verbose=true", + "--runInBand", + "--watch", + "${file}" + ], + "console": "integratedTerminal", + "internalConsoleOptions": "neverOpen", + "trace": "all" +} ``` This will run jest, targetting the spec file currently open in the editor. `vscode`'s debugger can now be used to add breakpoints and inspect tests as you would in Chrome DevTools. - **Note**: This package requires Node.js 12.0.0 or later. It is not compatible with older versions. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/edit-navigation/README.md b/packages/edit-navigation/README.md index 2f8c23db78e82..3ab83af295cc1 100644 --- a/packages/edit-navigation/README.md +++ b/packages/edit-navigation/README.md @@ -179,4 +179,10 @@ return ( _This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/edit-post/README.md b/packages/edit-post/README.md index d8b3233e1e73f..f551ec4c53302 100644 --- a/packages/edit-post/README.md +++ b/packages/edit-post/README.md @@ -504,4 +504,10 @@ _Type_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/edit-site/README.md b/packages/edit-site/README.md index 7891425a9b4d3..d209d914ea91f 100644 --- a/packages/edit-site/README.md +++ b/packages/edit-site/README.md @@ -28,4 +28,10 @@ initialize( '#editor-root', blockEditorSettings ); _This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/edit-widgets/README.md b/packages/edit-widgets/README.md index 65788e53d86cb..3e3a651db2925 100644 --- a/packages/edit-widgets/README.md +++ b/packages/edit-widgets/README.md @@ -39,3 +39,11 @@ In order to make the experience as seamless as possible for users, the following - for every available widget, a variation of the widget block is registered so that the user can see and search by the exact name of what they need - all widgets that have a block equivalent (a block that fulfills the same function) can be made not available as a widget block variation via a filter - all core widgets that have a block equivalent are not available as a widget block variation + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/editor/README.md b/packages/editor/README.md index b760d80385001..dc8ec694de07a 100644 --- a/packages/editor/README.md +++ b/packages/editor/README.md @@ -119,4 +119,10 @@ Example: } )( window.wp.editor, window.wp.element ); ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/element/README.md b/packages/element/README.md index ab2f1a4d2bb0d..b882182dd637b 100755 --- a/packages/element/README.md +++ b/packages/element/README.md @@ -416,4 +416,10 @@ _Related_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/env/README.md b/packages/env/README.md index 2ad33f2606c0c..e28d654b93539 100644 --- a/packages/env/README.md +++ b/packages/env/README.md @@ -621,4 +621,10 @@ You can tell `wp-env` to use a specific PHP version for compatibility and testin } ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/escape-html/README.md b/packages/escape-html/README.md index c91b942a6a02f..4f54e8bb0ffce 100644 --- a/packages/escape-html/README.md +++ b/packages/escape-html/README.md @@ -131,4 +131,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index de758ce55e20f..d8e874cdca71d 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -84,4 +84,10 @@ If you are using WordPress' `.jshintrc` JSHint configuration and you would like } ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/format-library/README.md b/packages/format-library/README.md index 4937ff2722fb2..46a3fda497e74 100644 --- a/packages/format-library/README.md +++ b/packages/format-library/README.md @@ -12,4 +12,10 @@ npm install @wordpress/format-library --save _This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/hooks/README.md b/packages/hooks/README.md index 306d17734b0cf..3e9897c79952c 100644 --- a/packages/hooks/README.md +++ b/packages/hooks/README.md @@ -63,4 +63,10 @@ Whenever an action or filter is added or removed, a matching `hookAdded` or `hoo In non-minified builds developers can register a filter or action that will be called on _all_ hooks, for example: `addAction( 'all', 'namespace', callbackFunction );`. Useful for debugging, the code supporting the `all` hook is stripped from the production code for performance reasons. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/html-entities/README.md b/packages/html-entities/README.md index e7f5a18c38c88..211215c50a451 100644 --- a/packages/html-entities/README.md +++ b/packages/html-entities/README.md @@ -37,4 +37,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/i18n/README.md b/packages/i18n/README.md index 35f869a9052fe..dd18cc7cae0a9 100644 --- a/packages/i18n/README.md +++ b/packages/i18n/README.md @@ -224,4 +224,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/icons/README.md b/packages/icons/README.md index b31e9f20a6cc0..3c692db7539e1 100644 --- a/packages/icons/README.md +++ b/packages/icons/README.md @@ -26,4 +26,10 @@ import { Icon, check } from '@wordpress/icons'; | ------ | --------- | ------- | ----------------------- | | `size` | `integer` | `24` | Size of icon in pixels. | -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/interface/README.md b/packages/interface/README.md index 50b88e3a5462c..5dceda4dadb48 100644 --- a/packages/interface/README.md +++ b/packages/interface/README.md @@ -135,3 +135,11 @@ function MyEditorMenu() { ); } ``` + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/is-shallow-equal/README.md b/packages/is-shallow-equal/README.md index bae09ba6eca25..5827408baf136 100644 --- a/packages/is-shallow-equal/README.md +++ b/packages/is-shallow-equal/README.md @@ -93,4 +93,10 @@ npm run build:packages node ./packages/is-shallow-equal/benchmark ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/jest-console/README.md b/packages/jest-console/README.md index c101f09875b7f..2b32ad62c8ec9 100644 --- a/packages/jest-console/README.md +++ b/packages/jest-console/README.md @@ -115,4 +115,10 @@ specific arguments. Almost identical usage as `.toHaveErroredWith()`. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/jest-preset-default/README.md b/packages/jest-preset-default/README.md index fc1e7a024fdb8..6705c6db073c1 100644 --- a/packages/jest-preset-default/README.md +++ b/packages/jest-preset-default/README.md @@ -36,4 +36,10 @@ npm install @wordpress/jest-preset-default --save-dev - `transform` - keeps the default [babel-jest](https://github.com/facebook/jest/tree/HEAD/packages/babel-jest) transformer. - `verbose` - each individual test won't be reported during the run. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/jest-puppeteer-axe/README.md b/packages/jest-puppeteer-axe/README.md index 74de4b04a2d81..5f87b93f8a1cd 100644 --- a/packages/jest-puppeteer-axe/README.md +++ b/packages/jest-puppeteer-axe/README.md @@ -62,4 +62,10 @@ test( 'checks the test component with Axe excluding some button', async () => { } ); ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/keyboard-shortcuts/README.md b/packages/keyboard-shortcuts/README.md index 57eb1ad190707..4138b44a8e685 100644 --- a/packages/keyboard-shortcuts/README.md +++ b/packages/keyboard-shortcuts/README.md @@ -53,4 +53,10 @@ _Parameters_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/keycodes/README.md b/packages/keycodes/README.md index 084686a033730..8aeb4000d5778 100644 --- a/packages/keycodes/README.md +++ b/packages/keycodes/README.md @@ -213,4 +213,10 @@ Keycode for ZERO key. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/lazy-import/README.md b/packages/lazy-import/README.md index e9faecb5b3381..c0659c153b456 100644 --- a/packages/lazy-import/README.md +++ b/packages/lazy-import/README.md @@ -88,4 +88,10 @@ Function to call if and when the module is being installed. Since installation c An installation can be assumed to finish once the returned promise is resolved. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/library-export-default-webpack-plugin/README.md b/packages/library-export-default-webpack-plugin/README.md index 9bfecb161cc70..c806260200b98 100644 --- a/packages/library-export-default-webpack-plugin/README.md +++ b/packages/library-export-default-webpack-plugin/README.md @@ -42,4 +42,10 @@ module.exports = { }; ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/list-reusable-blocks/README.md b/packages/list-reusable-blocks/README.md index ec27702eaee3d..ea0c754a3b62c 100644 --- a/packages/list-reusable-blocks/README.md +++ b/packages/list-reusable-blocks/README.md @@ -14,4 +14,10 @@ npm install @wordpress/list-reusable-blocks --save _This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/media-utils/README.md b/packages/media-utils/README.md index 80c34e21608e2..d3190cfce178c 100644 --- a/packages/media-utils/README.md +++ b/packages/media-utils/README.md @@ -44,3 +44,11 @@ Beware that first onFileChange is called with temporary blob URLs and then with Media upload component provides a UI button that allows users to open the WordPress media library. It is normally used in conjunction with the filter `editor.MediaUpload`. The component follows the interface specified in https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/media-upload/README.md, and more details regarding its usage can be checked there. + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/notices/README.md b/packages/notices/README.md index 21d845e3caa7f..7d2f888947f04 100644 --- a/packages/notices/README.md +++ b/packages/notices/README.md @@ -20,4 +20,10 @@ For more information about consuming from a data store, refer to [the `@wordpres For a full list of actions and selectors available in the `core/notices` namespace, refer to the [_Notices Data_ Handbook page](/docs/reference-guides/data/data-core-notices.md). -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/npm-package-json-lint-config/README.md b/packages/npm-package-json-lint-config/README.md index 5cc57a1783fb9..f0de29305a07e 100644 --- a/packages/npm-package-json-lint-config/README.md +++ b/packages/npm-package-json-lint-config/README.md @@ -58,4 +58,10 @@ Or to a `.npmpackagejsonlintrc.json` file in the root of your repo: } ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/nux/README.md b/packages/nux/README.md index 5405757c0e73c..5a372a4b07407 100644 --- a/packages/nux/README.md +++ b/packages/nux/README.md @@ -105,4 +105,10 @@ console.log( 'Currently showing:', guide.currentTipId ); console.log( 'Next to show:', guide.nextTipId ); ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/plugins/README.md b/packages/plugins/README.md index 9f976eb20982f..9256b48530026 100644 --- a/packages/plugins/README.md +++ b/packages/plugins/README.md @@ -191,4 +191,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/postcss-plugins-preset/README.md b/packages/postcss-plugins-preset/README.md index 47f544dc884cf..3bd9530225319 100644 --- a/packages/postcss-plugins-preset/README.md +++ b/packages/postcss-plugins-preset/README.md @@ -12,4 +12,10 @@ npm install @wordpress/postcss-plugins-preset --save **Note**: This package requires Node.js 12.0.0 or later. It is not compatible with older versions. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/postcss-themes/README.md b/packages/postcss-themes/README.md index 0406dd5ed023f..558fd1a24cb14 100644 --- a/packages/postcss-themes/README.md +++ b/packages/postcss-themes/README.md @@ -12,4 +12,10 @@ npm install @wordpress/postcss-themes --save **Note**: This package requires Node.js 12.0.0 or later. It is not compatible with older versions. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/prettier-config/README.md b/packages/prettier-config/README.md index 68730d2d4d543..3829e44d92564 100644 --- a/packages/prettier-config/README.md +++ b/packages/prettier-config/README.md @@ -26,4 +26,10 @@ Alternatively, add this to `.prettierrc` file: extends: ['@wordpress/prettier-config'] ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/primitives/README.md b/packages/primitives/README.md index 6f78930f30e73..0213ac53f8b30 100644 --- a/packages/primitives/README.md +++ b/packages/primitives/README.md @@ -29,4 +29,10 @@ const myElement = ( _This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/priority-queue/README.md b/packages/priority-queue/README.md index cf5a5fa121c31..bc4504d029e5c 100644 --- a/packages/priority-queue/README.md +++ b/packages/priority-queue/README.md @@ -44,4 +44,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/project-management-automation/README.md b/packages/project-management-automation/README.md index 4c35538a3fa38..3f2b4383c3a56 100644 --- a/packages/project-management-automation/README.md +++ b/packages/project-management-automation/README.md @@ -31,4 +31,10 @@ jobs: _None._ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/react-i18n/README.md b/packages/react-i18n/README.md index 5444f5b97e7ed..eac2e3798e2d1 100644 --- a/packages/react-i18n/README.md +++ b/packages/react-i18n/README.md @@ -90,4 +90,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/react-native-aztec/README.md b/packages/react-native-aztec/README.md index 6ce542510d608..79dfb6ea8d367 100644 --- a/packages/react-native-aztec/README.md +++ b/packages/react-native-aztec/README.md @@ -241,3 +241,11 @@ view manager. # License GPL v2 + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/react-native-bridge/README.md b/packages/react-native-bridge/README.md index 1ade4cdeb9c48..390ca109c1720 100644 --- a/packages/react-native-bridge/README.md +++ b/packages/react-native-bridge/README.md @@ -44,3 +44,11 @@ import RNReactNativeGutenbergBridge from '@wordpress/react-native-bridge'; // TODO: What to do with the module? RNReactNativeGutenbergBridge; ``` + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/react-native-editor/README.md b/packages/react-native-editor/README.md index 8f332e75e1ac0..5b985132e6c68 100644 --- a/packages/react-native-editor/README.md +++ b/packages/react-native-editor/README.md @@ -9,3 +9,11 @@ Please review [Getting Started for the React Native based Mobile Gutenberg](/doc ## License Gutenberg Mobile is an Open Source project covered by the [GNU General Public License version 2](LICENSE). + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/readable-js-assets-webpack-plugin/README.md b/packages/readable-js-assets-webpack-plugin/README.md index b1a4f33b85941..807cd307a8d5a 100644 --- a/packages/readable-js-assets-webpack-plugin/README.md +++ b/packages/readable-js-assets-webpack-plugin/README.md @@ -33,7 +33,14 @@ module.exports = { ``` **Note:** -- Multiple instances of the plugin are not supported and may produced unexpected results; -- It assumes your webpack pipeline is already generating a `.min.js` JS asset file for each JS entry-point. -

Code is Poetry.

+- Multiple instances of the plugin are not supported and may produced unexpected results; +- It assumes your webpack pipeline is already generating a `.min.js` JS asset file for each JS entry-point. + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/redux-routine/README.md b/packages/redux-routine/README.md index d13c2beef5693..53a5086adbe86 100644 --- a/packages/redux-routine/README.md +++ b/packages/redux-routine/README.md @@ -122,4 +122,10 @@ deepEqual( action.next( jsonResult ).value, { If your action creator does not assign the yielded result into a variable, you can also use `Array.from` to create an array from the result of the action creator. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/reusable-blocks/README.md b/packages/reusable-blocks/README.md index 2733d7a22e69c..542d6e82fe1f3 100644 --- a/packages/reusable-blocks/README.md +++ b/packages/reusable-blocks/README.md @@ -108,4 +108,10 @@ function MyDeleteReusableBlockButton( { id } ) { } ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/rich-text/README.md b/packages/rich-text/README.md index 69fc3ce70ad9a..98c5efdadc50b 100644 --- a/packages/rich-text/README.md +++ b/packages/rich-text/README.md @@ -481,4 +481,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/scripts/README.md b/packages/scripts/README.md index 0bff7047f7bac..66d6e514ab0f2 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -651,4 +651,10 @@ module.exports = { If you follow this approach, please, be aware that future versions of this package may change what webpack and Babel plugins we bundle, default configs, etc. Should those changes be necessary, they will be registered in the [package’s CHANGELOG](https://github.com/WordPress/gutenberg/blob/HEAD/packages/scripts/CHANGELOG.md), so make sure to read it before upgrading. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/server-side-render/README.md b/packages/server-side-render/README.md index 39ae91658b7a4..55dc97ec09134 100644 --- a/packages/server-side-render/README.md +++ b/packages/server-side-render/README.md @@ -176,3 +176,11 @@ register_block_type( ) ); ``` + +## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/shortcode/README.md b/packages/shortcode/README.md index e731d44189bf2..4fd5f4eee58f9 100644 --- a/packages/shortcode/README.md +++ b/packages/shortcode/README.md @@ -144,4 +144,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/stylelint-config/README.md b/packages/stylelint-config/README.md index f0fbd2bae74e9..eb4a980901d09 100644 --- a/packages/stylelint-config/README.md +++ b/packages/stylelint-config/README.md @@ -56,4 +56,10 @@ For example, to change the `indentation` to four spaces and turn off the `number } ``` -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/token-list/README.md b/packages/token-list/README.md index 3b25bad86a841..e7e20b07b2f0d 100644 --- a/packages/token-list/README.md +++ b/packages/token-list/README.md @@ -46,4 +46,10 @@ The implementation of the `DOMTokenList` interface provided through `@wordpress/ TokenList's own internal implementation of the `DOMTokenList` interface does not leverage any of these functions, so it is not necessary to polyfill them for basic usage. -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/url/README.md b/packages/url/README.md index c829b1c199d3d..eea0a41a1eb49 100644 --- a/packages/url/README.md +++ b/packages/url/README.md @@ -538,4 +538,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/viewport/README.md b/packages/viewport/README.md index 8f247b51f6aaf..d6f58ce4ca28f 100644 --- a/packages/viewport/README.md +++ b/packages/viewport/README.md @@ -124,4 +124,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/warning/README.md b/packages/warning/README.md index 768b3bc63fc36..6adfe73b6d459 100644 --- a/packages/warning/README.md +++ b/packages/warning/README.md @@ -53,4 +53,10 @@ _Parameters_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/widgets/README.md b/packages/widgets/README.md index adf82996c5982..9259f592043bb 100644 --- a/packages/widgets/README.md +++ b/packages/widgets/README.md @@ -14,4 +14,10 @@ npm install @wordpress/widgets _This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.

diff --git a/packages/wordcount/README.md b/packages/wordcount/README.md index 17b35180f2bb0..4615f623f7225 100644 --- a/packages/wordcount/README.md +++ b/packages/wordcount/README.md @@ -39,4 +39,10 @@ _Returns_ -

Code is Poetry.

+## Contributing to this package + +This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. + +To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). + +

Code is Poetry.