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

Better Testing Guidelines #1174

Closed
wants to merge 2 commits into from
Closed

Conversation

ahmadawais
Copy link
Contributor

Quite a few folks have had been wondering how to test Gutenberg Editor after installing and building. I add a tip.

Quite a few folks have had been wondering [how to test](https://make.wordpress.org/core/2017/06/12/whats-new-in-gutenberg-june-12th/#comment-32701) Gutenberg Editor after installing and building. I add a tip.
@aduth
Copy link
Member

aduth commented Jun 15, 2017

Should we adapt the TESTS.md file for this purpose?

CONTRIBUTING.md is linked to both when creating a new issue or a new pull request. To avoid an overwhelming blob of text (perhaps evidenced by the unique quote styling you'd applied to the snippet), we might consider splitting messaging between code-focused contributions and usability-testing contributions by one of:

  • Better sectioning within CONTRIBUTING.md
  • References from CONTRIBUTING.md to separate specific documents
  • Creating an issue template with helpful information

CONTRIBUTING.md Outdated
@@ -14,6 +14,8 @@ If you have a local WordPress environment, you can clone this repository into yo

Some good options for a local WordPress development environment include <a href="https://varyingvagrantvagrants.org/">VVV</a> and <a href="https://www.mamp.info/">Mamp</a>.

> Once the plugin is intalled, and you have built it through `npm` go to the post list and hover over a post row to click `Edit in Gutenberg` link. That should do it for initial testing.
Copy link
Member

Choose a reason for hiding this comment

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

Should we mention the admin bar menu which includes both a Demo and New Post submenus?

Nitpicking, but the last sentence doesn't add much value to the text, and could be dropped without sacrificing clarity.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aduth I think the admin bar menu gets ignored, pretty easily. But feel free to edit the text before you merge this one. Or let me know if I should do it.

@ahmadawais
Copy link
Contributor Author

@aduth I just pushed an update to the text. Take a look.

@aduth aduth added the [Type] Developer Documentation Documentation for developers label Jun 16, 2017
@aduth
Copy link
Member

aduth commented Jun 16, 2017

What do you think about my questions in #1174 (comment) ? Trying to decide where best this belongs.

Also, with plugin release imminent, might we want to encourage usability testing through the plugin instead? We'd still want to provide pointers to where they'll find the editor in the admin, but they'll not be as relevant to clone/build instructions.

@gziolo
Copy link
Member

gziolo commented Sep 22, 2017

I think it would be good idea to add this text to TESTS.md and reference it from CONTRIBUTING.md.

@karmatosed
Copy link
Member

+1 to using TESTS.md for this so closing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants