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 documentation for testing and CI #3532

Merged
merged 6 commits into from
Jun 2, 2020
Merged

Add documentation for testing and CI #3532

merged 6 commits into from
Jun 2, 2020

Conversation

cgewecke
Copy link
Collaborator

@cgewecke cgewecke commented May 21, 2020

Description

Addresses #3528.

  • Adds some description of what tests we have and their intent.
  • Adds a link to the browser visual inspection test in the PR template

Human-readable-version

Draft...would love feedback about stuff to add or clarify.

(Have organized this as table which might not really be the right format, idk)

Fixes #3528

Type of change

  • Documentation

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have updated the CHANGELOG.md file in the root folder.

@coveralls
Copy link

coveralls commented May 21, 2020

Coverage Status

Coverage remained the same at 89.638% when pulling 0460c18 on issue/3528 into 5829347 on 1.x.

@cgewecke cgewecke added 1.x 1.0 related issues Documentation Relates to project wiki or documentation Review Needed Maintainer(s) need to review labels May 21, 2020
@@ -29,3 +29,6 @@ Fixes #(issue)
- [ ] I ran `npm run build-all` and tested the resulting files from `dist` folder in a browser.
- [ ] I have updated the `CHANGELOG.md` file in the root folder.
- [ ] I have tested my code on the live network.
- [ ] The browser visual inspection check looks ok: [sudden-playground.surge.sh][1]
Copy link
Collaborator

Choose a reason for hiding this comment

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

cool, but might be a little confusing since other PRs can overwrite it at any time. just thinking out loud, i wonder if we could "append" to the index.html in surge, that would be cool to have a running log of successful (or not) results.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes this would be ideal: e.g sudden.playground.surge.sh/<branch>/<commit>

As I read surge issue 119, there's no built-in support for this per se and we'd need to maintain our own store of previously published pages.

We can definitely highlight the potential overwrite more clearly in the published page though, will amend this PR for that.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Copy link
Collaborator

@ryanio ryanio left a comment

Choose a reason for hiding this comment

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

really great, wish I had this when I started 😄

@cgewecke cgewecke marked this pull request as ready for review May 29, 2020 16:41
TESTING.md Outdated Show resolved Hide resolved
TESTING.md Outdated Show resolved Hide resolved
TESTING.md Outdated Show resolved Hide resolved
scripts/html/index.html Outdated Show resolved Hide resolved
scripts/html/index.html Outdated Show resolved Hide resolved
Copy link
Collaborator

@ryanio ryanio left a comment

Choose a reason for hiding this comment

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

looks so great! 🎉

TESTING.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.x 1.0 related issues Documentation Relates to project wiki or documentation Review Needed Maintainer(s) need to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CI and testing documentation
3 participants