1.9 KiB
Contributing
Thank you for reading this far. pplus-web is the site of Programming+: the editor, the views, the embeds and the Quarto extension, over pplus-core. 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, 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 core and the site, then every test of the site
pixi run dev # build, then serve on http://localhost:4173
Without pixi, with Node 20 or later: npm install && npm test.
AGENTS.md has the rules every change follows, whoever writes it; a change to what a program means belongs in pplus-core, under its own rules.
Reporting a bug
Say what you did, what you expected, and what happened, with the share link of the view (it holds the whole state) and the browser you used. Where to file issues will be in the README once the repository is public.
Style
US English, plain sentences, in the code and in everything a student reads.
A commit says the problem first, then what each part of the change does; a fix comes with a test that fails without it, and a change to the interface comes with a short manual check list in its message.
Every change for a user has a line in CHANGELOG.md.