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

Contribution guidelines for examples, with an example example #1427

Merged
merged 4 commits into from
Dec 3, 2023

Conversation

gfscott
Copy link
Contributor

@gfscott gfscott commented Oct 17, 2023

This PR lays out a draft model for examples, as well as some initial documentation for contributing examples.

Notes:

  • I copied in a subset of @juanpprieto's Multipass example repo verbatim. It's a reasonably complex example which is why we wanted to start with it. I thought it was important that the file links in the README worked as intended to give a full sense of how it feels.
  • However, JP's original repo covers two cases: persisting a session through to checkout, and authenticating with Google Oauth. I dropped the third-party auth thing here. I think two separate examples might be better? Or even three — two for each separate use case, and a third showing the combo. Things to discuss on the tradeoffs there.
  • We should nail down more specifics on the functional baseline for examples — as in, should each example folder have its own package.json file, its own remix config, a server.ts file, etc. I think our long-term intent is to make it easy to run these locally, so what's the minimum set of files that gets us there without becoming a maintenance headache?

Checklist

  • I've read the Contributing Guidelines
  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've added a changeset if this PR contains user-facing or noteworthy changes
  • I've added tests to cover my changes
  • I've added or updated the documentation

@gfscott gfscott requested a review from a team October 17, 2023 15:35
@gfscott gfscott self-assigned this Oct 17, 2023
Copy link
Member

@benjaminsehl benjaminsehl 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 awesome, thank you guys!

Copy link
Member

@benjaminsehl benjaminsehl left a comment

Choose a reason for hiding this comment

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

In addition to the comment on the readme — want to confirm that our multipass is living up to our expectations around what's stated in the contributing guide cc: @juanpprieto

docs/examples/README.md Show resolved Hide resolved
rename

rename

.
@benjaminsehl benjaminsehl merged commit fc1365c into main Dec 3, 2023
5 of 8 checks passed
@benjaminsehl benjaminsehl deleted the gfscott/example-readmes branch December 3, 2023 19:15
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