Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure readme file, document manual testing, various updates #341

Merged
merged 47 commits into from
Jan 23, 2023

Conversation

gudmdharalds
Copy link
Contributor

@gudmdharalds gudmdharalds commented Jan 18, 2023

This pull request restructures the README.md file, moving sections of it into separate files, and adding a new file about versioning, testing and deployment. The updated README.md file refers to these new files and still includes the relevant headings. Various sections of the documentation is updated along the way.

TODO:

  • Break README.md file up, move content to new files.
  • Add new file about versioning, testing and deployment.
  • Move section about manual testing away from RELEASING.md into TESTING.md.
  • Add script for manual testing to repository and document in TESTING.md.
  • [N/A] Add/update tests -- unit and/or integrated (if needed)
  • [N/A] Add to, or update, Scan run detail report as applicable
  • [N/A] Check status of automated tests
    • Changes to documentation and added support script only. No impact on tests.
  • [N/A] Ensure PHPDoc comments are up to date for functions added or altered
  • Changelog entry (for VIP) [ Changelog for version 1.3.4 #333 ]

@gudmdharalds gudmdharalds added this to the 1.3.4 milestone Jan 18, 2023
Copy link
Collaborator

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto-approved pull request #341 as it contains only auto-approvable files -- non-functional changes to PHP files or file-types that are auto-approvable (css, csv, eot, gif, gz, ico, ini, jpeg, jpg, json, less, map, md, mdown, mo, mp4, otf, pcss, pdf, po, pot, png, sass, scss, styl, ttf, txt, woff, woff2, yml).

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot dismissed their stale review January 19, 2023 20:19

Dismissing obsolete review; not approved any longer

@gudmdharalds gudmdharalds changed the title Restructure readme file Restructure readme file, document manual testing steps Jan 19, 2023
@gudmdharalds gudmdharalds changed the title Restructure readme file, document manual testing steps Restructure readme file, document manual testing Jan 19, 2023
@gudmdharalds gudmdharalds changed the title Restructure readme file, document manual testing Restructure readme file, document manual testing, various updates Jan 20, 2023
@gudmdharalds gudmdharalds merged commit f450954 into trunk Jan 23, 2023
@gudmdharalds gudmdharalds deleted the update/readme-restructure branch January 23, 2023 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants