Files
pplus-core/CONTRIBUTING.md
T
alexm 401084bab3
Test / gate (push) Failing after 19m0s
Initial commit
2026-11-12 22:23:54 -05:00

2.1 KiB

Contributing

Thank you for reading this far. pplus-core is the part of Programming+ that has to be right, and it is maintained by one person; the rules below keep it honest about what it can take on.

Two rules first

  • No outside code is merged until a contributor license agreement exists. Until then, bug reports, failing programs, questions, and documentation fixes are welcome, and code changes are read and used as guidance but not merged. The agreement will be short and will ask you to confirm that you may license your change under Apache-2.0.
  • No contributions from students enrolled at the University of Pittsburgh. The maintainer teaches there, and this project is separate from that job. Students may use Programming+ like anyone else.

Running the checks

Programming+ uses pixi for its environments; it brings the pinned Mojo, Node and Python. From a clone with its submodule (git clone --recurse-submodules):

pixi run test    # build, then every test
pixi run ci      # the gate: every test, no Mojo program of ours failing, every library routine checked,
                 # every program built by the pinned compiler, and a short fuzz (docs/ci.md)

Without pixi, with Node 20 or later: npm install && npm test. AGENTS.md has the rules every change follows, whoever writes it: the gate, the generated files nobody edits by hand, and why a claim about Mojo needs the real compiler's answer.

Reporting a bug

Say what you ran, what you expected, and what happened. The best report is a program: a pseudo program and the output it should print, a Mojo program and what the compiler says about it, or a program the prover calls proved that a run breaks (that one is a soundness bug, the most serious kind; docs/engines.md says how they are pinned). Where to file issues will be in the README once the repository is public.

Style

US English, plain sentences. A commit says the problem first, then what each part of the change does, and a fix comes with a test that fails without it. Every change for a user has a line in CHANGELOG.md.