Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 3.08 KB

Is this your first contribution to Open Source? If yes, please read the excellent first time contributor guide at https://opensource.guide/how-to-contribute/.

Generally, we welcome contributions from volunteers. A number of improvements we'd like to see implemented are listed at general/docs/contributions.md in addition to the issues tagged with "helpwanted". For new developers, there are issues tagged good first issue.

We're happy to consider anything you'd like to contribute. However, some parts of the tlaplus repository follow a very strict contribution policy. So before you start working on anything, please discuss with us what you want to do. You can do that on the issues page. We do not want to reject your 1k LOC patch because the actual change is not considered sensible by us.

Except for TLAPS, the TLA+ tools are maintained in Eclipse. For instructions on how to setup the Eclipse IDE, please go to general/ide/README.md..

For build instructions, please read our developers guide.

Nightly Builds

Nightly builds of the Toolbox and tla2tools are found at https://nightly.tlapl.us/products/ and https://nightly.tlapl.us/dist/. The Toolbox contains the latest version of tla2tools.jar for command-line usage in its root directory.

It is also possible to configure the Toolbox to automatically update to nightly (experimental) builds.

Note that it is called nightly for historical reasons, but builds are actually triggered by commits.

Linux

For dpkg-based Linux derivates such as Debian and Ubuntu, you can add the Toolbox's nightly package repository to your source list:

$ cat /etc/apt/sources.list.d/tlaplus.list
deb https://nightly.tlapl.us/toolboxUpdate/ ./
$ curl -fsSL https://tla.msr-inria.inria.fr/jenkins.pub | sudo apt-key add -

macOS

The Toolbox's nightly builds are also made available as a cask through homebrew versions:

$ brew tap homebrew/cask-versions
$ brew install tla-plus-toolbox-nightly

Quality Metrics

We collect quality metrics. If you want to help out with the project, the reports indicate several low hanging fruits to pick.