prql icon indicating copy to clipboard operation
prql copied to clipboard

Improve developer onboarding docs

Open max-sixty opened this issue 2 years ago • 2 comments

I've tried to make it easy to get started with PRQL development, but I'm not sure whether that's been successful, so I'd really like feedback on what's currently missing.

  • Is DEVELOPMENT.md clear?
  • Do people use the task setup-dev? Would folks prefer a copy-pasta?
    • At least a copy-paste to get to being able to run cargo insta test? (as discussed with @aljazerzen on Discord)
    • FWIW I use task setup-dev a lot to update my dependencies, I do think there are some great advantages to having something encapsulated & tested. But probably it's not for everyone. (@aljazerzen doesn't use it)
  • Should we more clearly indicate what is required to get set up in that doc vs. general commentary? We want to have something that someone looks at and thinks "OK that will take 2 min, let's do it"
  • Would folks use a Codespaces? We could provide a template.

What are good projects which have done this well? I've been chatting with @charliermarsh — ruff has had huge success at getting new contributors. Their equivalent doc is https://github.com/charliermarsh/ruff/blob/main/CONTRIBUTING.md. Their environment is simpler — just cargo install cargo-insta, no other targets / language bindings / website tools. So my guess is that the distinction between the projects is more in how easy it is to do a PR, rather than getting set up, but very open to thoughts / feedback.

Thanks in advance, all comments welcome

max-sixty avatar Jan 04 '23 22:01 max-sixty

I prefer:

  • my editor of choice over Codespaces,
  • basic rust toolchain over helpers that I don't understand fully.

I don't know what other people use, so any feedback from @MarinPostma, @BlurrechDev, @boramalper or @JettChenT would be appreciated.

aljazerzen avatar Jan 05 '23 09:01 aljazerzen

Hi! To provide some feedback on my onboarding process for developing:

  • I did use task setup-dev. The DEVELOPMENT.md is pretty clear on how to set up the development environment.
  • Codespaces would be useful, as the target folder for building this project takes up several gigabytes of storage, which could become a burden for developers who have limited storage space available.

JettChenT avatar Jan 05 '23 11:01 JettChenT

This got lots of changes, so closing

max-sixty avatar Feb 01 '23 09:02 max-sixty