quantified.uncertainty/squiggle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Ozzie Gooen 2022-04-11 20:24:46 -04:00 committed by GitHub
parent 811c3bd6e7
commit 3c82a88c6a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -110,9 +110,9 @@ If a function is called externally (in a different file), and has either:
2. Three paramaters or more. 2. Three paramaters or more.
**Module naming: Use x_y as module names** **Module naming: Use x_y as module names**
For example: ``Myname__Myproject__Add.res``. Rescript/Ocaml both require files to have unique names, so long names are needed to keep different parts separate from each other. For example: ``Myname_Myproject_Add.res``. Rescript/Ocaml both require files to have unique names, so long names are needed to keep different parts separate from each other.
See [this page](https://dev.to/yawaramin/a-modular-ocaml-project-structure-1ikd) for more information. See [this page](https://dev.to/yawaramin/a-modular-ocaml-project-structure-1ikd) for more information. (Though note that they use two underscores, and we do one. We might refactor that later.
**Module naming: Don't rename modules** **Module naming: Don't rename modules**
We have some of this in the Reducer code, but generally discourage it. We have some of this in the Reducer code, but generally discourage it.