From dccd529e27963a939e44ef9f02bac134974a12b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor?= <27339341+priethor@users.noreply.github.com> Date: Fri, 4 Mar 2022 19:54:35 +0100 Subject: [PATCH 1/6] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 28 +++++++++------------------- 1 file changed, 9 insertions(+), 19 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 20ce318d5d2cb2..2793da379751ff 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,8 +2,14 @@ -## Description - +## What? + + +## How? + + +## Why? + ## Testing Instructions @@ -11,20 +17,4 @@ -## Screenshots - -## Types of changes - - - - - -## Checklist: -- [ ] My code is tested. -- [ ] My code follows the WordPress code style. -- [ ] My code follows the accessibility standards. -- [ ] I've tested my changes with keyboard and screen readers. -- [ ] My code has proper inline documentation. -- [ ] I've included developer documentation if appropriate. -- [ ] I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all `*.native.js` files for terms that need renaming or removal). -- [ ] I've updated related schemas if appropriate. +## Screenshots or screencast From dfab8fa1570deba31f955a9bb9787105ddee8801 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor?= <27339341+priethor@users.noreply.github.com> Date: Fri, 4 Mar 2022 20:25:02 +0100 Subject: [PATCH 2/6] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2793da379751ff..c055b8da57fb6d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,12 +5,12 @@ ## What? -## How? - - ## Why? +## How? + + ## Testing Instructions From 27ca911169e25fa61bca470c5591df27fa317e4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor?= <27339341+priethor@users.noreply.github.com> Date: Mon, 7 Mar 2022 13:56:43 +0100 Subject: [PATCH 3/6] Add instructions and relevant links to the top. --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c055b8da57fb6d..d561913f332ee1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,14 @@ - + +Hi there! Thanks for contributing to Gutenberg! + +If this is your first time contributing, you may find reviewing these guides first to be helpful: +- Overall process and best practices for pull requests: https://github.com/WordPress/gutenberg/blob/HEAD/docs/contributors/repository-management.md#pull-requests. +- Coding Standards: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/ +- Accessibility testing: https://github.com/WordPress/gutenberg/blob/HEAD/docs/contributors/accessibility-testing.md +- Gutenberg licensing: https://github.com/WordPress/gutenberg/blob/trunk/LICENSE.md + +--> ## What? From 21a0dab838620b35f6660347c56f2f054b5e2c41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor?= <27339341+priethor@users.noreply.github.com> Date: Mon, 7 Mar 2022 20:52:12 +0100 Subject: [PATCH 4/6] Reduce the introductory links to a single one Link to the Contributing Guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d561913f332ee1..2ac98e4c82aef5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,5 @@ - + ## What? From 6303f0588f6dab29639045b62923b32bc55a1154 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor?= <27339341+priethor@users.noreply.github.com> Date: Mon, 7 Mar 2022 21:01:57 +0100 Subject: [PATCH 5/6] Extend the contributing guidelines Extend the contributing guidelines by adding coding standards and accessibility testing. --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 765083d8b04584..cb706a73bdc097 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,10 @@ To learn all about contributing to the Gutenberg project, see the [Contributor G - As with all WordPress projects, we want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [Code of Conduct](/CODE_OF_CONDUCT.md). +- Contributors should review the [overall process and best practices for pull requests](https://github.com/WordPress/gutenberg/blob/trunk/docs/contributors/repository-management.md#pull-requests), adhering to WordPress' [JavaScript coding standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/) and [accessibility coding standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/accessibility/). + +- Accessibility should be top of mind and thoroughly tested by following the [accessibility testing instructions](https://github.com/WordPress/gutenberg/blob/HEAD/docs/contributors/accessibility-testing.md). + - You maintain copyright over any contribution you make. By submitting a pull request you agree to release that code under [Gutenberg's License](/LICENSE.md). ## Reporting Security Issues From 507c3bfd896d061884cb16674786b7b7434449e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor?= <27339341+priethor@users.noreply.github.com> Date: Tue, 8 Mar 2022 13:29:13 +0100 Subject: [PATCH 6/6] Add guideline asking contributors to check React Native files, too --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb706a73bdc097..cd137ea37201c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,8 @@ To learn all about contributing to the Gutenberg project, see the [Contributor G - Accessibility should be top of mind and thoroughly tested by following the [accessibility testing instructions](https://github.com/WordPress/gutenberg/blob/HEAD/docs/contributors/accessibility-testing.md). +- Verify that any changes in your PR that affect function/class/variable names are mirrored in the corresponding `.native.js` versions of the files to avoid introducing breaking changes in the [React Native Mobile Editor](https://github.com/WordPress/gutenberg/tree/trunk/docs/contributors/code/react-native). + - You maintain copyright over any contribution you make. By submitting a pull request you agree to release that code under [Gutenberg's License](/LICENSE.md). ## Reporting Security Issues