Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (43 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 1.35 KB
Raw

Contributing

1. Clone

git clone https://github.com/BratishkaErik/zigocracy
cd zigocracy

2. Build

./gradlew build

3. Run tests

./gradlew test

If you're iterating on one module, you can run just its tests for a faster loop:

./gradlew ":zon-grammar:test"   # parser only
./gradlew ":cli:test"           # CLI only

Run ./gradlew test before submitting to make sure everything still passes together.

4. Submit a pull request

  1. Create a feature branch.
  2. Make your changes.
  3. Run ./gradlew test and confirm everything passes.
  4. Push and open a PR against main.

That's it. Welcome!

Project structure

  • zon-grammar/ — ZON lexer, parser, AST, and token definitions
  • cli/ — main CLI entry point and terminal wrapper
  • meta-grammar-annotations/ — MetaGrammar annotation definitions
  • meta-grammar-processors/ — MetaGrammar annotation processors
  • docs/ — user-facing documentation