Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (32 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 1.77 KB

Contributing to rattleScript

This is a brand-surface repo. The compiler, type checker, borrow checker, codegen, and face transformer all live in affinescript.

Where to file what

Issue Repo
The face transformer mangles my code affinescript
The error message uses the wrong vocabulary for this face affinescript — the face vocabulary lives in lib/face.ml
New language feature needed (extern types, dependent types, etc.) affinescript
Brand README is unclear / wrong this repo
Example program doesn't compile this repo (and probably also affinescript if it's a transformer bug)
Tutorial / migration guide additions this repo
Add this face to my IDE / build tool this repo, but expect it to depend on affinescript work first

Local workflow

opam install affinescript     # installs the compiler
git clone https://github.com/hyperpolymath/rattlescript
cd rattlescript
just hello                    # smoke-test the example
just check examples/hello.affine
just preview examples/hello.affine

Pull requests

  • SPDX header on every new file (AGPL-3.0-or-later).
  • Run just hello and any other examples added before opening the PR.
  • If you're touching the face transformer, open the PR against affinescript, not here.

Code of conduct

See CODE_OF_CONDUCT.md (TBD; for now follow the affinescript code of conduct).