Files
alexm 568474d52f
Test (in pplus-core) / in-core (push) Failing after 28m44s
Initial commit
2026-11-12 22:23:48 -05:00

36 lines
2.2 KiB
Markdown

# Contributing
Thank you for reading this far.
pplus-library is the ground truth of Programming+: the routines, the Mojo corpus, and the programs the engines are held to. It is maintained by one person, and 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](https://pixi.sh/latest/) for its environments; it brings the pinned Mojo, Node and Python.
The checks are pplus-core's tasks; run them in a pplus-core clone, where this repository is the submodule `library/`:
```sh
pixi run test # build, then every test
pixi run library-check # every check of every routine, at every level
```
Without pixi, with Node 20 or later: `npm install && npm test` in pplus-core.
`mojo/corpus/` is Modular's material, harvested at pinned commits: a change to it comes from upstream through a new harvest, not from a patch here.
[AGENTS.md](AGENTS.md) has the rules every change follows, whoever writes it: one routine per file, the pseudo as the specification, the files only tools write, and how to cite a method.
## 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, and it belongs in `pseudo/prover/`).
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`.