Docs: QoL Updates to Contributing.md #10561
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added TOC Added language about requiring a Fork to submit PRs. Restructured Functional Test Project section. Kept all info just moved things around. Updated Gitpod Starter repo link. Removed Yarn v1-3 upgrade information as of v0.37.
pantheredeye
changed the title
Tobbe
approved these changes
May 12, 2024
|
Thanks Barrett! This document definitely needed some TLC 💚 |
Tobbe
added
changesets-ok
dac09
added a commit
that referenced
this pull request
May 15, 2024
…uth-store * 'main' of github.com:redwoodjs/redwood: chore(router): Add more code comments to analyzeRoutes (#10569) RSC: No need to use memo or useMemo in the server router (#10568) RSC: getViteConfig in rscWorker (#10567) Split RSC and RSA handling in rscWorker (#10565) RSC: Extract the fetchRSC function (#10564) RSC: Fix TODO regarding SSR in client.ts (#10562) Docs: QoL Updates to Contributing.md (#10561) Added warning note to not add WebAuthn (#10231) fix(rsc): Load all css links to support css with rsc (#10544) fix(cli): Add deprecation notice for edgio deployment (#10551) Define `process.env.NODE_ENV` in build process. (#10553) chore(docs): Update dbAuth and Supabase middleware READMEs (#10552) chore(deps): Upgrade React 19 to beta 20240508 (#10560) Revert "chore(deps): React beta 20240508 (#10558)" (#10559) chore(deps): React beta 20240508 (#10558) fix(functions): Fix context variable warning/error (#10556) fix(functions): Mock context in function test template (#10555) chore(middleware): Format code and comments and fix comment grammar (#10554)
Josh-Walker-GM
pushed a commit
that referenced
this pull request
May 15, 2024
Co-authored-by: Tobbe Lundberg <tobbe@tlundberg.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Quality of life updates for the contributing doc that lives in the rwfw root folder. I made some small changes here, keeping almost all of the content. I removed RW 0.37 references because I assume no contributor is really upgrading their framework code from 0.37 at this point in time.
Future consideration: It feels to me like this document is geared toward that new contributor who has cloned the framework code, has this opened in their IDE, and is looking for some guidance. I think the document could be reworked to present a better storyline, or flow, to that user persona.
An overview of my changes: