Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
ryanwaits
approved these changes
May 13, 2025
Contributor
ryanwaits
left a comment
ryanwaits
left a comment
There was a problem hiding this comment.
this is great! made a few minor copy edits and added a ui component for project structure ✅
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
2 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.
Description
Adds documentation explaining how to configure a Clarinet project properly and what is essential.
The idea is that, while
clarinet new <project>will set up the right boilerplate, Clarinet or Vitest upgrades may require specific settings to be updated by users in the future. It's not easy for developers to know what the settings should be.This documentation should be maintained to reflect our recommendations.
Just like https://github.com/hirosystems/clarity-starter/ is always maintained with the latest versions of everything.
This PR showcases the backbone of what needs to be set up.
@ryanwaits what do you think about it?