Skip to content

Commit

Permalink
GH-385: Simplify the PR template
Browse files Browse the repository at this point in the history
- Removed 'Best practices' section for being redundant
- Add square brackets for all the texts that should be replaced
  • Loading branch information
sampoturve committed Apr 19, 2024
1 parent c2f9650 commit 621a5f1
Showing 1 changed file with 11 additions and 40 deletions.
51 changes: 11 additions & 40 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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 <branch>
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:

<details>
<summary><h3>Accessibility:</h3></summary>
<p>
This project must support WCAG accessibility level AA <em>(edit this according to the requirements of your project)</em>. 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.

</p>
</details>
[List all the steps that should be performed to test the feature]

0 comments on commit 621a5f1

Please sign in to comment.