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

feat(docs): Stub List page #12418

Merged
merged 4 commits into from
Mar 14, 2019
Merged

feat(docs): Stub List page #12418

merged 4 commits into from
Mar 14, 2019

Conversation

lannonbr
Copy link
Contributor

@lannonbr lannonbr commented Mar 8, 2019

Description

I implemented a new page in the contributing section of the docs to aggregate all of the stubbed files in a single location so people can see any available articles that yet have to be written at a quick glance.

screenshot_2019-03-08 stub list gatsbyjs

Related Issues

Closes #12362

@lannonbr lannonbr requested a review from a team March 8, 2019 18:36
@lannonbr lannonbr requested a review from a team as a code owner March 8, 2019 18:36
Copy link
Contributor

@marcysutton marcysutton left a comment

Choose a reason for hiding this comment

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

This is a great contribution, thanks for the PR! I especially like how you're finding stubs dynamically so the list is easy to keep up to date. I wonder, though, if some test coverage could be added for the business logic so that we can ensure it doesn't break over time. Is that something you could work on?

@lannonbr
Copy link
Contributor Author

lannonbr commented Mar 8, 2019

If some test coverage could be added for the business logic so that we can ensure it doesn't break over time. Is that something you could work on?

Yeah definitely, I would have to look how to write tests for it, but I think it likely will be possible. Is there anywhere currently references for tests that are for logic for portions of the website?

Copy link
Contributor

@DSchau DSchau left a comment

Choose a reason for hiding this comment

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

Looks good! We don't really have a ton of unit tests for our www code but we certainly could add some.

Maybe a separate PR?

www/src/pages/contributing/stub-list.js Outdated Show resolved Hide resolved
Co-Authored-By: lannonbr <benjamin@lannonbr.com>
@lannonbr
Copy link
Contributor Author

lannonbr commented Mar 8, 2019

I'll go submit another commit to fix that lint error.

@DSchau, I'd be up for a pair session with someone to do the tests if someone is available to do such.

@DSchau
Copy link
Contributor

DSchau commented Mar 8, 2019

@lannonbr for sure - here's the general idea of how to get it up and running :)

DSchau#8

We'd have to add CI support, but that's fairly trivial!

@lannonbr
Copy link
Contributor Author

Opened up an issue for adding testing for the .org site: #12545.

@DSchau DSchau dismissed marcysutton’s stale review March 14, 2019 15:41

Let's revisit adding tests in a future PR!

Copy link
Contributor

@DSchau DSchau left a comment

Choose a reason for hiding this comment

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

Approving! We'll implement a testing suite next week so we can get a sanity check for some of this new functionality :)

@DSchau DSchau merged commit 2e550b1 into gatsbyjs:master Mar 14, 2019
@lannonbr lannonbr deleted the feat/stublist branch March 14, 2019 16:01
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

Successfully merging this pull request may close these issues.

3 participants