We are committed to make Dark easy to contribute to. Our contributor docs will help guide you through your first PR, find good projects to contribute to, and learn about the code base.
That said, we are still in the early stages of building out the new version of Dark, and are a bit behind on our docs -- much of the content in those docs is geared towards dark-classic. If you have any questions, please touch base in Discord.
- please refer to the dev setup docs
- try running
./scripts/run-cli help-- if this works, it confirms that at least most things are working.
scripts/run-backend-tests- Running unit tests
- Dark unit tests
The scripts/ directory is full of scripts. They automatically execute
in the dev container, even if they are run on the host (see
scripts/devcontainer/_assert-in-container
for how this works). Scripts starting with an underscore are primarily intended to be
run by other scripts. Scripts without an underscore are usually intended to be called
by a human, though they are often also called by other scripts as well.
If you've gotten this far, you're now ready to contribute your first PR.
scripts/run-in-docker bash
scripts/run-in-docker psql -d devdb
Config files (config/) define all env vars that you can use in Dark code.
All config vars must start with DARK_CONFIG. Changing a config variable in
config/dev requires restaring the devcontanier.
We've had mixed success with getting the VS Code debugger to work with Dark.
When it works, it supports breakpoints, stepping, inspecting the stack, etc.
You must launch the executable from VS Code for this to work -- attaching does not
currently seem to work. You can edit launch.json to change
what tests are run or how other binaries are started up, which should be straightforward.
That said, running tests with debugger support does seem to work -- again, adjust
launch.json to adjust which tests are run, and then run the "Tests" configuration.
(Disclaimer: this is out of date, and probably won't work).
You can get a REPL with all of the Dark libraries loaded by running:
- Contributor docs
- Writing docstrings in the Dark Standard library
- Logging and telemetry
- Docs around running Dark in production (for internal use)
These are compiled to create libraries and binaries.
These are put into containers, whose definitions are in containers/. We also have some containers which are defined entirely in their directory (typically, these have a self-contained codebase).