01Contribute
Help build Larrygram
Larrygram is MIT-licensed and developed on GitHub. Bug reports, test files, docs and code are all welcome.
Ways to help
- 01
Report a bug
Tell us what broke and how to make it happen again.
Report a bug - 02
Pick up an issue
Issues labeled “good first issue” are small and well described.
Good first issues - 03
Help wanted
Larger tasks where the project needs a hand.
Help wanted - 04
Improve these docs
Every docs page has an “Edit page” link. The website lives in its own repository.
Website repository
How changes land
Larrygram’s process is written down in AGENTS.md, and it applies to human contributors too:
- Work on your own branch, one task per branch.
- Run the quality gate before you open a pull request:
cargo xtask gate --quickwhile you work,cargo xtask gatebefore you hand off. - Keep to the clean-room rules: never use Microsoft code, binaries, icons, fonts, stencils, templates or sample drawings.
- Record every new asset in ATTRIBUTION.md, with its source and license.
A CONTRIBUTING guide, a code of conduct and a security policy are being prepared for the repository.
Set up a development environment
Clone the repository and build the workspace. The pinned toolchain installs itself through rustup.
git clone https://github.com/aprajnaparamita/larrygram.gitcd larrygramcargo build --workspacecargo run -p larrygram# Before you open a pull requestcargo xtask gate --quickcargo xtask gateThe full gate also needs cargo-deny, cargo-llvm-cov, a nightly toolchain with cargo-fuzz, and the wasm32-unknown-unknown target.
Code of conduct
Be kind, assume good intent and keep feedback about the work. Until the project publishes its own code of conduct, report problems to help@maitrigroup.co.
Security
Please do not report security problems in public issues. Use a private GitHub security advisory, or email help@maitrigroup.co.
Report privately