surrealdb/surrealdb.py

Documentation: CONTRIBUTING.md should include dev setup

Wouterkoorn opened this issue · 3 comments

Wouterkoorn commented

Description

I wanted to contribute to the project, starting with some minor fixes (e.g. typing), but I didn't find any instruction for a local dev setup. So I had to do my own trial and error:

  1. Clone the repo (my fork)
  2. pip install -r requirements.txt -r dev_requirements.txt.
  3. pytest tests/ -> ModuleNotFoundError: No module named 'surrealdb.rust_surrealdb'
  4. ./scripts/run_tests.sh -> ModuleNotFoundError: No module named 'docker'
  5. pip install docker
  6. ./scripts/run_tests.sh -> ModuleNotFoundError: No module named 'surrealdb.rust_surrealdb'
  7. cargo build
  8. pip install -e .
  9. ./scripts/run_tests.sh -> Succes!

So nothing crazy was required to get it working, but it would be nice if the required steps were briefly documented in the CONTRIBUTING.MD, rather than that everyone has to go through this trial&error process.

Make contributing easier, and you'll get more contributions 😄

Is there an existing issue for this?

  • I have searched the existing issues

Code of Conduct

  • I agree to follow this project's Code of Conduct
AlexFrid commented

Make contributing easier, and you'll get more contributions

Thanks, you're absolutely right about that, we'll document that 😅

  • ❤️1
maxwellflitton commented

@AlexFrid hey I'm going through the backlog, was this documented?

cr2007 commented

So nothing crazy was required to get it working, but it would be nice if the required steps were briefly documented in the CONTRIBUTING.MD, rather than that everyone has to go through this trial&error process.

Could you list the exact steps on how exactly does one get started (minus the trial and errors steps) ? I'm trying to build a basic Dev Container configuration to get started via Codespaces, so wanted to give these steps a go.