From 621a5f101fe55a94cd988691a5c4a9b101d02b3e Mon Sep 17 00:00:00 2001 From: Sampo Turve Date: Fri, 19 Apr 2024 14:23:11 +0300 Subject: [PATCH] GH-385: Simplify the PR template - Removed 'Best practices' section for being redundant - Add square brackets for all the texts that should be replaced --- .github/pull_request_template.md | 51 +++++++------------------------- 1 file changed, 11 insertions(+), 40 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3889e95..00c40d2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,52 +1,23 @@ -# Link to ticket: +## Ticket -[Add link to ticket] (if automatic linking is not used) +[Add a link to the ticket] -# Changes proposed in this PR: +## Description [Explain what was done and why. You can also add screenshots here if it helps.] -# How to test +## Testing -## Testing in feature environment: +### Feature environment -[Add link to feature environment] -https://[BRANCH-NAME].[PROJECT-NAME].dev.wdr.io/ +[Add a link to the feature environment] -[Add command how to get admin login url to the feature environment] -`ssh www-admin@[BRANCH-name]-shell.[PROJECT-NAME] -J www-admin@ssh.dev.wdr.io "drush uli"` +Drush uli: [Add a `drush uli` command to get (admin) login url to the feature environment] -## Local testing +### Setting up local environment -_Detail custom setup instructions if any - any drush commands, content reindexing, specific user to use, etc._ +[Detail custom setup instructions if any - any drush commands, content reindexing, specific user to use, etc.] - git fetch && git checkout - lando composer install - lando drush cim -y - lando drush cr +### Testing instructions -## Testing steps - -_Testing scenario goes here._ - -1. Do this. -2. Go there. -3. Validate that xyz is working. - -# Best practices: - -
-

Accessibility:

 -

-This project must support WCAG accessibility level AA (edit this according to the requirements of your project). To ensure this standard is met, remember to: - -- Perform automated checks using a tool such as Wave or SiteImprove. -- Test keyboard navigation: are all parts of the UI navigable using only the keyboard? Is the tab order logical? Can popups, menus etc be dismissed with the escape key? -- Test responsiveness, scaling and text reflow. -- Make sure no accessibility issues exist on either desktop or mobile views. -- If you have time, test with a screen reader such as VoiceOver (macOS), NVDA (Windows), or Orca (Linux). - -Use the [Accessibility Testing Cheat Sheet](https://intra.wunder.io/info/accessibility-group/accessibility-testing-cheat-sheet) for information on how to run these tests. - -

-
+[List all the steps that should be performed to test the feature]