diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 20ce318d5d2cb2..2ac98e4c82aef5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,9 +1,14 @@ - + - +## What? + -## Description - +## Why? + + +## How? + ## Testing Instructions @@ -11,20 +16,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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 765083d8b04584..cd137ea37201c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,12 @@ 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). + +- 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