Merged
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
m-hulbert
reviewed
Mar 27, 2025
Contributor
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
This looks good - only a couple of comments and then a question of whether we need this as a separate file, or can it just be a section in the CONTRIBUTING guide in the root of the repo?
examples/CONTRIBUTING.md
Outdated
|
|
||
| Add entries for each example to the `/examples/package.json` file under `workspaces` and `scripts`, an example of this is shown below: | ||
|
|
||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```json |
examples/CONTRIBUTING.md
Outdated
|
|
||
| ## Styling consistency | ||
|
|
||
| For styling consistency purposes, each example will need to use [Franken-ui](https://franken-ui.dev/) for components, and any other styling to use tailwindcss. |
Contributor
There was a problem hiding this comment.
Worth giving a few examples of each do you think?
examples/CONTRIBUTING.md
Outdated
|
|
||
| ## Shared configurations | ||
|
|
||
| All examples use config from the examples root directory. Update these files inside your project directory as needed: |
Contributor
There was a problem hiding this comment.
Is this not a requirement to point to the root config rather than 'as needed'?
m-hulbert
approved these changes
Apr 2, 2025
GregHolmes
force-pushed
the
EDU-1821-Create-a-guide-for-contributors
branch
from
bc7c392 to
fb0ed73
Compare
GregHolmes
changed the title
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
In this PR is a new CONTRIBUTING.md file, inside
/examples, which contains the guide for contributing to examples within the docs.