Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.03 KB

contributing.md

File metadata and controls

43 lines (31 loc) · 1.03 KB
Raw

Contributing

Project Structures

cli

Code for the command line interface.

example

Runtime example of Gularen documents.

source

  • Gularen/Library: Data-structures and algorithms used by Gularen.
  • Gularen/Frontend: Parsing code, from Gularen document to AST.
  • Gularen/Backend: Composing code, from AST to other content-type.

resource

example

Example documents.

spec/published

Specification documents.

spec/draft

Specification draft documents.

script

Utility scripts.

test

Test files.

Naming Convention

  • Use a tab for indentation.
  • Always attach braces on the same line.
  • macro should be written in SCREAMING_SNAKE_CASE.
  • namespace, class, and enum should be written in PascalCase.
  • function, variable, enum.field, and others should be written in camelCase.

Unit Test

Assuming you are using Linux or MacOS:

Run sh script/test-build.sh, you will get the build/gularen-test executable. Run sh script/test-run.sh to ensure all tests pass.