-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation: Update CONTRIBUTING docs (#15187)
* Documentation: Update CONTRIBUTING docs * Update links to getting started section
- Loading branch information
Showing
11 changed files
with
172 additions
and
148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,125 +10,9 @@ All WordPress projects are [licensed under the GPLv2+](/LICENSE.md), and all con | |
|
|
||
| This document covers the technical details around setup, and submitting your contribution to the Gutenberg project. | ||
|
|
||
| ## Getting Started | ||
| ## Developer Contributions | ||
|
|
||
| Gutenberg is a Node.js-based project, built primarily in JavaScript. | ||
|
|
||
| The easiest way to get started (on MacOS, Linux, or Windows 10 with the Linux Subsystem) is by running the Local Environment setup script, `./bin/setup-local-env.sh`. This will check if you have everything installed and updated, and help you download any extra tools you need. | ||
|
|
||
| For another version of Windows, or if you prefer to set things up manually, be sure to have <a href="https://nodejs.org/en/">Node.js installed first</a>. You should be running a Node version matching the [current active LTS release](https://github.com/nodejs/Release#release-schedule) or newer for this plugin to work correctly. You can check your Node.js version by typing `node -v` in the Terminal prompt. | ||
|
|
||
| If you have an incompatible version of Node in your development environment, you can use [nvm](https://github.com/creationix/nvm) to change node versions on the command line: | ||
|
|
||
| ``` | ||
| nvm install | ||
| nvm use | ||
| ``` | ||
|
|
||
| You also should have the latest release of [npm installed][npm]. npm is a separate project from Node.js and is updated frequently. If you've just installed Node.js which includes a version of npm within the installation you most likely will need also to update your npm installation. To update npm, type this into your terminal: `npm install npm@latest -g` | ||
|
|
||
| To test the plugin, or to contribute to it, you can clone this repository and build the plugin files using Node. How you do that depends on whether you're developing locally or uploading the plugin to a remote host. | ||
|
|
||
| ### Local Environment | ||
|
|
||
| First, you need a WordPress Environment to run the plugin on. The quickest way to get up and running is to use the provided docker setup. Install [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/) by following the most recent instructions on the docker site. | ||
|
|
||
| In the folder of your preference, clone this project and enter the working directory: | ||
| ```bash | ||
| git clone [email protected]:WordPress/gutenberg.git | ||
| cd gutenberg | ||
| ``` | ||
|
|
||
| Then, run a setup script to check if docker and node are configured properly and starts the local WordPress instance. You may need to run this script multiple times if prompted. | ||
| ``` | ||
| ./bin/setup-local-env.sh | ||
| ``` | ||
|
|
||
| **If you're developing themes, or core WordPress functionality alongside Gutenberg**, you can make the WordPress files accessible in `wordpress/` by following these instructions instead: | ||
|
|
||
| 1. If this is your first time setting up the environment, run `DOCKER_ENV=localwpdev ./bin/setup-local-env.sh` instead of `./bin/setup-local-env.sh` | ||
| 2. If you've already had the previous environment set up, you need to start fresh, and you can do that by first running `docker-compose down --rmi all`. After that, you can repeat step 1. | ||
| 3. If you turn off your computer or restart Docker, you can get your local WordPress dev environment back by typing `docker-compose -f docker-compose.yml -f docker-compose-localdev.yml up`. If you just run `docker-compose up`, you will get the vanilla install that doesn't expose the WordPress folder. | ||
|
|
||
| **If everything was successful**, you'll see the following ASCII art: | ||
| ``` | ||
| Welcome to... | ||
| ,⁻⁻⁻· . | | ||
| | ،⁓’. . |--- ,---. ,---. |---. ,---. ,---. ,---. | ||
| | | | | | |---' | | | | |---' | | | | ||
| `---' `---' `---’ `---’ ' ` `---' `---’ ` `---| | ||
| `---' | ||
| ``` | ||
|
|
||
| The WordPress installation should be available at `http://localhost:8888` (**Username**: `admin`, **Password**: `password`). | ||
| Inside the "docker" directory, you can use any docker command to interact with your containers. If this port is in use, you can override it in your `docker-compose.override.yml` file. If you're running [e2e tests](/docs/contributors/testing-overview.md#end-to-end-testing), this change will be used correctly. | ||
|
|
||
| To bring down this local WordPress instance later run: | ||
| ``` | ||
| docker-compose down | ||
| ``` | ||
|
|
||
| If you'd like to see your changes reflected in this local WordPress instance, run: | ||
| ``` | ||
| npm install | ||
| npm run dev | ||
| ``` | ||
|
|
||
| Alternatively, you can use your own local WordPress environment and clone this repository right into your `wp-content/plugins` directory. | ||
|
|
||
| Next, open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type `npm install` to get the dependencies all set up. Then you can type `npm run dev` in your terminal or command prompt to keep the plugin building in the background as you work on it. | ||
|
|
||
| WordPress comes with specific [debug systems](https://codex.wordpress.org/Debugging_in_WordPress) designed to simplify the process as well as standardize code across core, plugins and themes. It is possible to use environment variables (`WP_DEBUG` and `SCRIPT_DEBUG`) to update a site's configuration constants located in `wp-config.php` file. Both flags can be disabled at any time by running the following command: | ||
| ``` | ||
| SCRIPT_DEBUG=false WP_DEBUG=false ./bin/setup-local-env.sh | ||
| ``` | ||
| By default, both flags will be set to `true`. | ||
|
|
||
| ### On A Remote Server | ||
|
|
||
| Open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type `npm install` to get the dependencies all set up. Once that finishes, you can type `npm run build`. You can now upload the entire repository to your `wp-content/plugins` directory on your web server and activate the plugin from the WordPress admin. | ||
|
|
||
| You can also type `npm run package-plugin` which will run the two commands above and create a zip file automatically for you which you can use to install Gutenberg through the WordPress admin. | ||
|
|
||
| ## Workflow | ||
|
|
||
| A good workflow for new contributors to follow is listed below: | ||
| - Fork Gutenberg repository | ||
| - Clone forked repository | ||
| - Create a new branch | ||
| - Make code changes | ||
| - Commit code changes within the newly created branch | ||
| - Push branch to forked repository | ||
| - Submit Pull Request to Gutenberg repository | ||
|
|
||
| Ideally name your branches with prefixes and descriptions, like this: `[type]/[change]`. A good prefix would be: | ||
|
|
||
| - `add/` = add a new feature | ||
| - `try/` = experimental feature, "tentatively add" | ||
| - `update/` = update an existing feature | ||
|
|
||
| For example, `add/gallery-block` means you're working on adding a new gallery block. | ||
|
|
||
| You can pick among all the <a href="https://github.com/WordPress/gutenberg/issues">tickets</a>, or some of the ones labelled <a href="https://github.com/WordPress/gutenberg/labels/Good%20First%20Issue">Good First Issue</a>. | ||
|
|
||
| The workflow is documented in greater detail in the [repository management](/docs/contributors/repository-management.md) document. | ||
|
|
||
| ## Playground | ||
|
|
||
| The Gutenberg repository also includes a static Gutenberg playground that allows testing and developing in a WordPress-agnostic context. This is very helpful for developing reusable components and trying generic JavaScript modules without any backend dependency. | ||
|
|
||
| You can launch the playground by running `npm run playground:start` locally. The playground should be available on [http://localhost:1234](http://localhost:1234). | ||
|
|
||
| ## Testing | ||
|
|
||
| Gutenberg contains both PHP and JavaScript code and encourages testing and code style linting for both. It also incorporates end-to-end testing using [Google Puppeteer](https://developers.google.com/web/tools/puppeteer/). You can find out more details in [Testing Overview document](/docs/contributors/testing-overview.md). | ||
|
|
||
| ## Managing Packages | ||
|
|
||
| This repository uses [lerna] to manage Gutenberg modules and publish them as packages to [npm]. This enforces certain steps in the workflow which are described in details in [packages](/packages/README.md) documentation. | ||
|
|
||
| Maintaining dozens of npm packages is difficult—it can be tough to keep track of changes. That's why we use `CHANGELOG.md` files for each package to simplify the release process. As a contributor you should add an entry to the aforementioned file each time you contribute adding production code as described in [Maintaining Changelogs](/packages/README.md#maintaining-changelogs) section. | ||
| Please see the [Developer Contributions section](/docs/contributors/develop.md) of the Contributor Handbook. | ||
|
|
||
| ## How Can Designers Contribute? | ||
|
|
||
|
|
@@ -147,16 +31,3 @@ If you're contributing to the documentation of any component from the `@wordpres | |
| ## Reporting Security Issues | ||
|
|
||
| Please see [SECURITY.md](/SECURITY.md). | ||
|
|
||
| ## Localizing Gutenberg Plugin | ||
|
|
||
| To translate Gutenberg in your locale or language, [select your locale here](https://translate.wordpress.org/projects/wp-plugins/gutenberg) and translate *Development* (which contains the plugin's string) and/or *Development Readme* (please translate what you see in the Details tab of the [plugin page](https://wordpress.org/plugins/gutenberg/)). | ||
|
|
||
| A Global Translation Editor (GTE) or Project Translation Editor (PTE) with suitable rights will process your translations in due time. | ||
|
|
||
| Language packs are automatically generated once 95% of the plugin's strings are translated and approved for a locale. | ||
|
|
||
| The eventual inclusion of Gutenberg into WordPress core means that more than 51% of WordPress installations running a translated WordPress installation will have Gutenberg's translated strings compiled into the core language pack as well. | ||
|
|
||
| [lerna]: https://lernajs.io/ | ||
| [npm]: https://www.npmjs.com/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,15 @@ | ||
| # Developer Contributions | ||
|
|
||
| Please see [CONTRIBUTING.md](https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md) for technical details on how to setup and make contributions to the Gutenberg repository. | ||
| Please also see [CONTRIBUTING.md](https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md) for general information about contributions to the Gutenberg repository. | ||
|
|
||
| The following resources offer additional information for developers who wish to contribute to Gutenberg: | ||
|
|
||
| * [Getting Started](/docs/contributors/getting-started.md). | ||
| * [Git Workflow](/docs/contributors/git-workflow.md). | ||
| * [Coding Guidelines](/docs/contributors/coding-guidelines.md) outline additional patterns and conventions used in the Gutenberg project. | ||
| * [Gutenberg Block Grammar](/docs/contributors/grammar.md) | ||
| * [Testing Overview](/docs/contributors/testing-overview.md) for PHP and JavaScript development in Gutenberg. | ||
| * [Scripts](/docs/contributors/scripts.md) a list of vendor and internal scripts available to plugin developers. | ||
| * [Gutenberg Release Process](/docs/contributors/release.md) a checklist for the different type of releases for Gutenberg project. | ||
| * [Gutenberg Block Grammar](/docs/contributors/grammar.md). | ||
| * [Scripts](/docs/contributors/scripts.md) - a list of vendor and internal scripts available to plugin developers. | ||
| * [Managing Packages](/docs/contributors/managing-packages.md). | ||
| * [Gutenberg Release Process](/docs/contributors/release.md) - a checklist for the different type of releases for Gutenberg project. | ||
| * [Localizing Gutenberg Plugin](/docs/contributors/localizing.md) - a guide on how to translate Gutenberg in your locale or language. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Getting Started | ||
|
|
||
| Gutenberg is a Node.js-based project, built primarily in JavaScript. | ||
|
|
||
| The easiest way to get started (on MacOS, Linux, or Windows 10 with the Linux Subsystem) is by running the Local Environment setup script, `./bin/setup-local-env.sh`. This will check if you have everything installed and updated, and help you download any extra tools you need. | ||
|
|
||
| For another version of Windows, or if you prefer to set things up manually, be sure to have <a href="https://nodejs.org/en/">Node.js installed first</a>. You should be running a Node version matching the [current active LTS release](https://github.com/nodejs/Release#release-schedule) or newer for this plugin to work correctly. You can check your Node.js version by typing `node -v` in the Terminal prompt. | ||
|
|
||
| If you have an incompatible version of Node in your development environment, you can use [nvm] to change node versions on the command line: | ||
|
|
||
| ``` | ||
| nvm install | ||
| nvm use | ||
| ``` | ||
|
|
||
| You also should have the latest release of [npm installed][npm]. npm is a separate project from Node.js and is updated frequently. If you've just installed Node.js which includes a version of npm within the installation you most likely will need also to update your npm installation. To update npm, type this into your terminal: `npm install npm@latest -g` | ||
|
|
||
| To test the plugin, or to contribute to it, you can clone this repository and build the plugin files using Node. How you do that depends on whether you're developing locally or uploading the plugin to a remote host. | ||
|
|
||
| ## Local Environment | ||
|
|
||
| First, you need a WordPress Environment to run the plugin on. The quickest way to get up and running is to use the provided docker setup. Install [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/) by following the most recent instructions on the docker site. | ||
|
|
||
| In the folder of your preference, clone this project and enter the working directory: | ||
| ```bash | ||
| git clone [email protected]:WordPress/gutenberg.git | ||
| cd gutenberg | ||
| ``` | ||
|
|
||
| Then, run a setup script to check if docker and node are configured properly and starts the local WordPress instance. You may need to run this script multiple times if prompted. | ||
| ``` | ||
| ./bin/setup-local-env.sh | ||
| ``` | ||
|
|
||
| **If you're developing themes, or core WordPress functionality alongside Gutenberg**, you can make the WordPress files accessible in `wordpress/` by following these instructions instead: | ||
|
|
||
| 1. If this is your first time setting up the environment, run `DOCKER_ENV=localwpdev ./bin/setup-local-env.sh` instead of `./bin/setup-local-env.sh` | ||
| 2. If you've already had the previous environment set up, you need to start fresh, and you can do that by first running `docker-compose down --rmi all`. After that, you can repeat step 1. | ||
| 3. If you turn off your computer or restart Docker, you can get your local WordPress dev environment back by typing `docker-compose -f docker-compose.yml -f docker-compose-localdev.yml up`. If you just run `docker-compose up`, you will get the vanilla install that doesn't expose the WordPress folder. | ||
|
|
||
| **If everything was successful**, you'll see the following ASCII art: | ||
| ``` | ||
| Welcome to... | ||
| ,⁻⁻⁻· . | | ||
| | ،⁓’. . |--- ,---. ,---. |---. ,---. ,---. ,---. | ||
| | | | | | |---' | | | | |---' | | | | ||
| `---' `---' `---’ `---’ ' ` `---' `---’ ` `---| | ||
| `---' | ||
| ``` | ||
|
|
||
| The WordPress installation should be available at `http://localhost:8888` (**Username**: `admin`, **Password**: `password`). | ||
| Inside the "docker" directory, you can use any docker command to interact with your containers. If this port is in use, you can override it in your `docker-compose.override.yml` file. If you're running [e2e tests](/docs/contributors/testing-overview.md#end-to-end-testing), this change will be used correctly. | ||
|
|
||
| To bring down this local WordPress instance later run: | ||
| ``` | ||
| docker-compose down | ||
| ``` | ||
|
|
||
| If you'd like to see your changes reflected in this local WordPress instance, run: | ||
| ``` | ||
| npm install | ||
| npm run dev | ||
| ``` | ||
|
|
||
| Alternatively, you can use your own local WordPress environment and clone this repository right into your `wp-content/plugins` directory. | ||
|
|
||
| Next, open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type `npm install` to get the dependencies all set up. Then you can type `npm run dev` in your terminal or command prompt to keep the plugin building in the background as you work on it. | ||
|
|
||
| WordPress comes with specific [debug systems](https://codex.wordpress.org/Debugging_in_WordPress) designed to simplify the process as well as standardize code across core, plugins and themes. It is possible to use environment variables (`WP_DEBUG` and `SCRIPT_DEBUG`) to update a site's configuration constants located in `wp-config.php` file. Both flags can be disabled at any time by running the following command: | ||
| ``` | ||
| SCRIPT_DEBUG=false WP_DEBUG=false ./bin/setup-local-env.sh | ||
| ``` | ||
| By default, both flags will be set to `true`. | ||
|
|
||
| ## On A Remote Server | ||
|
|
||
| Open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type `npm install` to get the dependencies all set up. Once that finishes, you can type `npm run build`. You can now upload the entire repository to your `wp-content/plugins` directory on your web server and activate the plugin from the WordPress admin. | ||
|
|
||
| You can also type `npm run package-plugin` which will run the two commands above and create a zip file automatically for you which you can use to install Gutenberg through the WordPress admin. | ||
|
|
||
| [npm]: https://www.npmjs.com/ | ||
| [nvm]: https://github.com/creationix/nvm | ||
|
|
||
| ## Playground | ||
|
|
||
| The Gutenberg repository also includes a static Gutenberg playground that allows testing and developing in a WordPress-agnostic context. This is very helpful for developing reusable components and trying generic JavaScript modules without any backend dependency. | ||
|
|
||
| You can launch the playground by running `npm run playground:start` locally. The playground should be available on [http://localhost:1234](http://localhost:1234). | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.