Skip to content

docs: Split DEVELOPMENT.md from CONTRIBUTING.md #1010

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

Merged
merged 2 commits into from
Oct 9, 2022
Merged

docs: Split DEVELOPMENT.md from CONTRIBUTING.md #1010

merged 2 commits into from
Oct 9, 2022

Conversation

richb-hanover
Copy link
Contributor

I felt the urge to separate the community-building aspect from the CONTRIBUTING.md document from the "how to develop" information there.

I also thought it was important that the new DEVELOPMENT.md file point a newcomer to the various components of the PRQL project, and where to find information about how to work with them.

I'm not sure I have got the split between these documents entirely correct. Feel free to move information between them. Thanks.

Update package.json for playgrond in attempt to remove npm warnings
@richb-hanover richb-hanover changed the title Split DEVELOPMENT.md from CONTRIBUTING.md docs: Split DEVELOPMENT.md from CONTRIBUTING.md Oct 9, 2022
@max-sixty
Copy link
Member

This looks very reasonable, thanks for contributing @richb-hanover . I admittedly wasn't familiar with DEVELOPING.md, but some light Googling suggests it's fairly standard — e.g. https://github.com/github/docs/blob/main/contributing/development.md.

Did you intend to bump the playground dependencies?

@richb-hanover
Copy link
Contributor Author

Did you intend to bump the playground dependencies?

Yes, I moved them up to the current versions, according to npmjs.com. I was trying to evade the deprecation warnings from npm install.

But no dice: I still see warnings for [email protected]: and [email protected] that seem to get pulled in from @svgr/[email protected] that gets pulled in from @svgr/[email protected] which itself is a dependency of [email protected]

Thanks.

@max-sixty
Copy link
Member

max-sixty commented Oct 9, 2022

Could we split that out

But no dice: I still see warnings for [email protected]: and [email protected] that seem to get pulled in from @svgr/[email protected] that gets pulled in from @svgr/[email protected] which itself is a dependency of [email protected]

😬

Thanks for trying though!

@max-sixty max-sixty merged commit 711c4a3 into PRQL:main Oct 9, 2022
@max-sixty
Copy link
Member

Cheers @richb-hanover — great to have you as a contributor!

@richb-hanover
Copy link
Contributor Author

@max-sixty Did some research... There's a long-standing pull request to update the dependencies of wasm-react-scripts. The interesting conversation is at: facebook/create-react-app#12172 (comment)

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