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

[EPIC] Test critical APIs #7620

Closed
1 of 5 tasks
m-allanson opened this issue Aug 24, 2018 · 4 comments
Closed
1 of 5 tasks

[EPIC] Test critical APIs #7620

m-allanson opened this issue Aug 24, 2018 · 4 comments
Assignees

Comments

@m-allanson
Copy link
Contributor

Who will own this?

What Area of Responsibility does this fall into? Who will own the work, and who needs to be aware of the work?

Area of Responsibility:

  • OSS

Summary

Identify critical untested areas of Gatsby and add testing for them to improve the reliability of Gatsby.

How will this impact Gatsby?

Domains

List the impacted domains here

Components

List the impacted Components here

Goals

What are the top 3 goals you want to accomplish with this epic? All goals should be specific, measurable, actionable, realistic, and timebound.

How will we know this epic is a success?

What changes must we see, or what must be created for us to know the project was a success. How will we know when the project is done? How will we measure success?

User Can Statement

  • User can...

Metrics to Measure Success

  • We will see an increase /decrease in...

Additional Description

In a few sentences, describe the current status of the epic, what we know, and what's already been done.

What are the risks to the epic?

In a few sentences, describe what high-level questions we still need to answer about the project. How could this go wrong? What are the trade-offs? Do we need to close a door to go through this one?

What questions do we still need to answer, or what resources do we need?

Is there research to be done? Are there things we don’t know? Are there documents we need access to? Is there contact info we need? Add those questions as bullet points here.

How will we complete the epic?

What are the steps involved in taking this from idea through to reality?

How else could we accomplish the same goal?

Are there other ways to accomplish the goals you listed above? How else could we do the same thing?

Next Steps

  • Under Pipeline select Proposed Epics (only if you are NOT the AoR owner)
  • Under Assignees select the AoR Owneryou listed in the Epic
  • Under Labels select Epic
  • Select Create Epic

You're all done!

@cpboyd
Copy link
Contributor

cpboyd commented Aug 25, 2018

I'd like to draw attention to bugs already reported in #7568 and #7564 regarding wrapRootElement and wrapPageElement.

I'm going to work on a PR for those.

@cpboyd
Copy link
Contributor

cpboyd commented Aug 25, 2018

Edited to cleanup:
In build mode, the ssr versions of both are applied in the build-html stage static-entry.js (which seems to make sense as these would be HTML changes).

While the browser versions are applied in both the build-javascript (production) and develop stages, which are called when we start parsing Javascript.

Update 3:
It seems that there aren't any specific issues with the new APIs.
I was trying to follow the changes to gatsby-plugin-jss, which seems to have a bug that I've reported in #7716.

I'll try to work on a docs PR when I have some free time.

@KyleAMathews
Copy link
Contributor

@cpboyd hey! Could you make individual issues for the the bugs you discovered? We're closing this issue as it's a bit ambiguous in favor of more specific issues.

@cpboyd
Copy link
Contributor

cpboyd commented Sep 20, 2018

@KyleAMathews Really, it ultimately boiled down to #7716.

I've been meaning to see if I can help add to the docs the stuff I've learned about the new APIs, but I've been busy with other things.

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

4 participants