Skip to content
Language:English
Download

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

How changes land

Larrygram’s process is written down in AGENTS.md, and it applies to human contributors too:

  1. Work on your own branch, one task per branch.
  2. Run the quality gate before you open a pull request: cargo xtask gate --quick while you work, cargo xtask gate before you hand off.
  3. Keep to the clean-room rules: never use Microsoft code, binaries, icons, fonts, stencils, templates or sample drawings.
  4. 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.

AGENTS.md · ATTRIBUTION.md

Set up a development environment

Clone the repository and build the workspace. The pinned toolchain installs itself through rustup.

Terminal
git clone https://github.com/aprajnaparamita/larrygram.gitcd larrygramcargo build --workspacecargo run -p larrygram# Before you open a pull requestcargo xtask gate --quickcargo xtask gate

The 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