Thanks for your interest in contributing!
shellcheck is used to determine best practices and is enforced on pull requests. Contributors using vscode are encouraged to install the shellcheck extension for vscode to avoid unnecessary pull request denials.
The JavaScript and rholang portions of RDev endorses the use of ocap. In order to support robust composition and cooperation without vulnerability, code in this project should adhere to object capability discipline.
-
Memory safety and encapsulation
-
There is no way to get a reference to an object except by creating one or being given one at creation or via a message; no casting integers to pointers, for example. JavaScript is safe in this way.
From outside an object, there is no way to access the internal state of the object without the object's consent (where consent is expressed by responding to messages). We use
Object.freezeand closures rather than properties onthisto achieve this.
-
-
Primitive effects only via references
- The only way an object can affect the world outside itself is
via references to other objects. All primitives for interacting
with the external world are embodied by primitive objects and
anything globally accessible is immutable data. There must be
no
open(filename)function in the global namespace, nor may such a function be imported. We use a convention of only accessing ambient authority inside WARNING sections.
- The only way an object can affect the world outside itself is
via references to other objects. All primitives for interacting
with the external world are embodied by primitive objects and
anything globally accessible is immutable data. There must be
no
-
pyrdev Testing framework
- pyrdev is in its infancy. It currently does not adhere to ocap discipline. Enhancements to the testing framework will be expected to remediate this oversight.