Rattle-compiler

This is the repository for Rattle language compiler.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

When making commits, follow the commit guide:

Commit message

<type>(<scope>): <summary>
  │       │          │
  │       │          └─⫸ Brief summary of the commit, without a period at its end
  │       │
  │       └─⫸ Commit Scope: lexer|parser|compiler|utils|general|github
  │                         
  └─⫸ Commit Type: docs|feat|fix|perf|refactor|test

Commit summary should start lowercase

Type

Must be one of the following:

• docs: Documentation and comment changes
• feat: A new feature
• fix: A bug fix (NOTE: if the bug is from a certain commit, write "fixes #<commit_SHA>" before bug description
• perf: Code change improving performance
• refactor: Purely naming changes or cleanup
• test: Adding missing tests or correcting existing tests

Reverting commits

If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit.

The content of the commit message body should contain:

• information about the SHA of the commit being reverted in the following format: "This reverts commit <SHA>"
• a clear description of the reason for reverting the commit message.

License

GPL-3.0-or-later License