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.

Sign up for GitHub

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

Jump to bottom

Update CONTRIBUTING.md #3114

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Update CONTRIBUTING.md #3114

merged 1 commit into from
Feb 21, 2024

Conversation

apedroferreira
Copy link
Member

@apedroferreira apedroferreira commented Jan 22, 2024 •
edited
Loading

Fix contribution guide section about running Toolpad for local development with linked packages.
It should also work with pnpm and link:, not sure if that's preferable?

@apedroferreira
Update CONTRIBUTING.md
86f751d 
Fix contribution guide for running Toolpad for local development with linked packages.
It should also work with `pnpm` and `link:`, not sure if that's preferable?

Also it looks like HMR doesn't work for changes to the runtime code when using this approach, but haven't been able to figure out why so far - I think it used to work before...


Signed-off-by: Pedro Ferreira <[email protected]>
@apedroferreira apedroferreira added the docs Improvements or additions to the documentation label Jan 22, 2024
@apedroferreira apedroferreira self-assigned this Jan 22, 2024
@apedroferreira apedroferreira mentioned this pull request Jan 23, 2024
Closed
1 task
@apedroferreira
Copy link
Member Author

Should we use yarn instructions here? Or update the instructions to pnpm?

@apedroferreira apedroferreira requested a review from a team February 19, 2024 15:25
@Janpot
Copy link
Member

Janpot commented Feb 19, 2024 •
edited
Loading

Should we use yarn instructions here? Or update the instructions to pnpm?

the latter if possible, otherwise the former. portal: dependencies don't exist in pnpm, there is injected but I don't believe it works as seamless as portal:. Might have to reinstall on every change (which should be faster than with yarn though)

Janpot
Janpot approved these changes Feb 19, 2024
View reviewed changes
Copy link
Member

@Janpot Janpot left a comment

Choose a reason for hiding this comment

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

If no equivalent workflow exists in pnpm

@apedroferreira
Copy link
Member Author

Should we use yarn instructions here? Or update the instructions to pnpm?

the latter if possible, otherwise the former. portal: dependencies don't exist in pnpm, there is injected but I don't believe it works as seamless as portal:. Might have to reinstall on every change (which should be faster than with yarn though)

Just using "@mui/toolpad-core": "link:../mui-toolpad-pedro/packages/toolpad-core" has been working well for me I think.

@apedroferreira apedroferreira merged commit 591952b into master Feb 21, 2024
11 checks passed
@apedroferreira apedroferreira deleted the apedroferreira-patch-1 branch February 21, 2024 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Janpot Janpot Janpot approved these changes

Assignees

@apedroferreira apedroferreira

Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@apedroferreira @Janpot