-
Notifications
You must be signed in to change notification settings - Fork 3
chore: add muse dev config #39
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Contributing to ToggleShop | ||
|
|
||
| ToggleShop is an OpenFeature demo app. Contributions are welcome, whether that's fixing a bug, improving a scenario, or testing new OpenFeature functionality. | ||
|
|
||
| ## Developer setup | ||
|
|
||
| We use [mise](https://mise.jdx.dev) to manage tool versions. It pins both Node.js and the OpenFeature CLI per-project, so every contributor gets the same environment. | ||
|
|
||
| 1. [Install mise](https://mise.jdx.dev/getting-started.html) | ||
| 2. Install project tools: | ||
| ```sh | ||
| mise install | ||
| ``` | ||
| 3. Install dependencies: | ||
| ```sh | ||
| npm install | ||
| ``` | ||
| 4. Start the app: | ||
| ```sh | ||
| npm run dev | ||
| ``` | ||
|
|
||
| If you prefer nvm, the `.nvmrc` file is still present. You'll need to [install the OpenFeature CLI](https://github.com/open-feature/cli#installation) separately. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The documentation states that |
||
|
|
||
| ## Generated files | ||
|
|
||
| The React hooks and Node.js client in `src/generated/` are generated by the OpenFeature CLI from `flags.json` and `.openfeature.yaml`. If you change flag definitions, regenerate them before committing: | ||
|
|
||
| ```sh | ||
| npm run generate-flags | ||
| ``` | ||
|
|
||
| CI will fail if `src/generated/` is out of date with the flag definitions. | ||
|
|
||
| ## DCO sign-off | ||
|
|
||
| All commits to OpenFeature repositories require a [Developer Certificate of Origin (DCO)](https://developercertificate.org/) sign-off: | ||
|
|
||
| ```sh | ||
| git commit -s -m "your commit message" | ||
| ``` | ||
|
|
||
| ## Running tests | ||
|
|
||
| ```sh | ||
| npm test | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,4 @@ | ||||||
| [tools] | ||||||
| node = "20" | ||||||
| "github:open-feature/cli" = "0.4.1" | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The OpenFeature CLI version
Suggested change
|
||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "$schema": "https://docs.renovatebot.com/renovate-schema.json", | ||
| "extends": [ | ||
| "github>open-feature/community-tooling" | ||
| ] | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
misesetup instructions are missing the activation step. Without activatingmisein the shell (e.g., viaeval "$(mise activate bash)"or the shell hook), subsequent commands likenpm installandnpm run devwill use the system's default Node.js version instead of the one pinned inmise.toml. Consider adding a note about activation or recommending the use ofmise execfor these commands.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gemini is referring to https://mise.jdx.dev/getting-started.html#activate-mise, which we should add to the instructions as well.