i am grateful that you are considering helping out, it really does mean a lot! johnny is a bot with a lot of moving components and due to the fact it is conditionally compiled extra care must be taken while implementing new features! in order to make the development lifecycle as beginner friendly as possible, we use a couple of tools while developing johnny. these are as follows:
- just - a task runner
- taplo - a toml toolkit, formats all of the toml files
- sea-orm-cli - cli to generate files related to sea-orm, the ORM we use
- cargo-generate - scaffolding tool for new packages
- cargo-all-features - build/test all feature flag combinations
- cargo-clean-recursive - clean target directories recursively
You can install all of the above using the following command:
cargo install just taplo-cli sea-orm-cli cargo-generate cargo-all-features
All workflows are defined in our justfile and each task can be run using just <task>. All available tasks are documented below.
- clean - cleans all target directories recursively
- format - formats all code using rustfmt, and toml files using taplo
- new-package - generates a new package using the template
- new-migration <name> - generates a new database migration
- build-all - build every feature combination
we adopt the contributor covenant code of conduct, so please make all of our lives easier and follow it [:
as development ramps up, we may have a development hub on discord. watch this space.
we use the stable toolchain. please make sure you are not using the nightly toolchain, it will cause us many headaches.
there is a special dev compiler feature that you will likely want to have enabled which we do not mention in the consumer guide. it adds some extra debugging tools to help you develop easier!
licensed with the opinionated queer license v1.1 - tl;dr see here :]