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

Add testing/contributing instructions to README #80

Open
Mr0grog opened this issue Aug 3, 2023 · 0 comments
Open

Add testing/contributing instructions to README #80

Mr0grog opened this issue Aug 3, 2023 · 0 comments

Comments

@Mr0grog
Copy link
Owner

Mr0grog commented Aug 3, 2023

I finally added real tests a few months ago, but failed to document how they work and, relatedly, how fixtures work. This really needs to be clearly documented in the README (probably in a section about contributing/developing in general).

I wrote up a mini-explainer in this comment, but it doesn’t cover everything: #74 (comment)

Important points:

  • e2e and unit tests
    • What belongs in each
    • How to run them (npm test vs npm run test-e2e vs npm run test-unit)
  • Selecting which browsers to run using the BROWSERS environment variable.
  • How Google Docs fixtures work.
    • Downloading/updating them.
    • What the deal is with <name>.copy.html vs. <name>.export.html.
    • Adding new fixtures.
    • How to use them in a test.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant