docs: Improve E2E test setup documentation #522
Conversation
|
Welcome @Pasta-coder ! Thank you for this contribution. Tagged Jayasanka to review :) |
|
See openmrs/openmrs-esm-patient-chart#2773 for additional inspiration :) |
|
@denniskigen this PR was opened for a series of improving docs across all repos , openmrs/openmrs-esm-patient-chart#2773 is also a part of same series , following is the link of talk https://talk.openmrs.org/t/kickstart-your-openmrs-journey-beginner-friendly-docs-contribution/47170 |
|
@Pasta-coder Thanks a lot for your contribution! 🙏 It might be better to update the existing E2E docs by adding any missing commands or additional context there. You can take some inspiration from this PR |
|
Maybe to improve the visibility of the E2E docs, we could simply reference the documentation file in the main README instead. What do you think, @denniskigen? |
Requirements
Summary
The existing documentation for setting up and running End-to-End (E2E) tests was minimal and often caused confusion for developers, particularly around:
Required environment variables
Steps to target either a local or remote backend
This PR enhances the E2E testing documentation in the main README.md by:
Providing clear, step-by-step instructions for configuring the Playwright E2E test environment
Introducing a new .env.example file that explains the purpose and usage of all required environment variables
Adding explicit instructions for running the tests against both a local backend and the dev3 remote server
Clarifying the exact commands needed to execute the tests
These improvements will streamline the developer workflow and make it easier to validate changes through E2E testing.
Screenshots
no UI changes
Related Issue
(Jira: O3-5071)(https://openmrs.atlassian.net/browse/O3-5071)
Other
This PR adds documentation for setting up and running the End-to-End (E2E) tests, as the instructions were missing from the README.md.
This standardizes the documentation to be consistent with other OpenMRS repositories, following the pattern established in openmrs/openmrs-esm-patient-management#2000.