This repo contains a bunch of software maintained by the buildbtw team. Check the respective directories for their READMEs.
- buildbtw-poc - the proof of concept buildbtw implementation
- arch-pkg-repo-updater - a tool to sync package repositories
- ✅ Collect initial user stories
- ✅ Build an exploratory PoC to discover unknown unknowns and validate the approach we've planned
- ⚙️ Write RFC, outlining major components & architecture
- ⚙️ Build and deploy MVP
- Iterate on the MVP to improve the service, writing new RFCs and requirements as needed
We're using the issue tracker for requirements and user stories. We're planning to use labels to allow filtering the issues:
- by need: "must", "should", "could", "won't"
- by effort: XL, L, M, S
- by scope: feature, bug, docs, refactor, ...
Issues are grouped using milestones. Prioritization happens through user stories which reflect our high-level goals.
Information on prior art, technical background, feedback from user interviews and other notes are gathered in the notes folder.
- Install Rust. It's recommended to work with the stable toolchain by default, but to format the code, you'll need the nightly toolchain as well. With rustup:
rustup install stable nightly
rustup default stable
- Install
just(pacman -S justorcargo install just) - For license checking: Install
reuse(pacman -S reuse) - For security auditing: Install
cargo-deny(pacman -S cargo-denyorcargo install cargo-deny)
There are a bunch of commands you can run at this level. Run just to view all of them.
just ci-devto check whether the repo as a whole would pass CIjust licensesto check license compliancejust denyto audit dependencies for security vulnerabilities.just lintto runcargo fmtandcargo clippyjust lint-fixto automatically fix lints and formattingjust formatto format the source codejust testto run testsjust watch-testto run tests and auto-rerun on code changes
just buildto build in debug modejust build-releaseto build in release modejust benchto run performance benchmarksjust cleanto clean workspace