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.

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

Add docs for contributing #1639

Merged
merged 2 commits into from
Mar 10, 2020
Merged

Add docs for contributing #1639

merged 2 commits into from
Mar 10, 2020

Conversation

epicfaace
Copy link
Member

Reasons for making this change

Add docs for contributing on a separate page, and also explain the development / deployment process for the new multi-package setup.

Checklist

  • I'm updating documentation
  • I'm adding or updating code
    • I've added and/or updated tests
    • I've updated docs if needed
  • I'm adding a new feature
    • I've updated the playground with an example use of the feature

@epicfaace epicfaace mentioned this pull request Mar 9, 2020
7 tasks
@epicfaace
Copy link
Member Author

@juliankigwana @Saulzi @chanceaclark let me know if this is clearer or if the docs I've added might need more clarification?

@Saulzi
Copy link
Contributor

Saulzi commented Mar 9, 2020

Yes definitely clarifies things, I will give this workflow a go now

@Saulzi
Copy link
Contributor

Saulzi commented Mar 9, 2020

unfortunately this did not work on #1610

Copy link
Contributor

@Saulzi Saulzi left a comment

Choose a reason for hiding this comment

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

All good

Comment on lines +48 to +54
cd packages/playground
npm run build:lib
npm link
cd ../core
npm link @rjsf/playground
npm start
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps this should be done when the user pulls the package rather than an additional step otherwise this works for me 👍

@Saulzi
Copy link
Contributor

Saulzi commented Mar 9, 2020

unfortunately this did not work on #1610

this did after install on bottom level and setting back index.js to be import Form, { withTheme } from "@rjsf/core"; in packages/playground on my branch

@epicfaace
Copy link
Member Author

Would it be simpler, rather than having each package have its own playground start scripts, to just have each package build their files (as @chanceaclark 's PR in #1606 does)? Then, in order to run the playground, one would just need to npm link whichever package they are working on, then run the playground from the packages/playground directory.

This thought came up because I was trying to add the playground to material-ui but realized that doing so would require a lot of overhead for each new package we add.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants