Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
122 lines (85 loc) · 5.03 KB

CONTRIBUTING.md

File metadata and controls

122 lines (85 loc) · 5.03 KB
Raw

Contributing To KrabbaScript

Since you're reading this, I want to thank you for considering contributing to KrabbaScript!

KrabbaScript is a simple yet powerful programming language, taking inspiration from C, Lua and Python. It is compiled, statically typed and type-safe, requiring a type for every variable declaration.

If you haven't done so already, please read the Code of Conduct first before continuing reading this.

AI policy

AI generated contributions are strictly forbidden unless you use AI as a tool for purely understanding the codebase. The following examples are disallowed:

  • AI generated code
  • Being a meat proxy
  • Writing a commit message with AI (If you don't know English, use a translator instead of using AI)
  • Writing pull requests with AI

Pull requests that meet these criteria will be closed.

Using AI to review/proofread and hunt bugs is permitted.

Setting up the development environment

To build and contribute to KrabbaScript, you'll need the following programs installed:

  • Golang version 1.27.1
  • Git (hopefully you already have this)
  • LLVM (not needed for now, due to the lack of a backend)

You can check if you have Golang installed by running:

go version

Start by cloning the repo

git clone https://github.com/KrabbaTek/krabbascript
cd krabbascript

And then build the project

go build

How to actually contribute

Okay, so you got everything set up, great! This is what you can do to contribute to KrabbaScript:

First, there are two levels of contributions: bugs, and ideas.

Bugs

If you went digging through the codebase and found something that shouldn't be, or found something that should be, then by all means submit a pull request! If any mistakes were made, like we were already working on it or it has been fixed, then we'll let you know.

Here's a walkthrough on submitting a pull request for a bug specifically:

First, tell us about the bug, unless it's extremely obvious. Give a description including what triggers it, when, why, etc.

Secondly, tell us what you did to fix it. If the bug is quite structural — that is, that the bug occurs due to something architectural and not just something like a typo — then submit an issue instead of a pull request. Please don't go changing something structural and then submitting a pull request.

In addition to this, be sure to follow the requirements listed below in the workflow section.

Finally, before submitting, make sure your code aligns with the style guide for KrabbaScript. If it does, then go ahead and submit and we'll review it as soon as we can.

Ideas

Ideas are always welcome — it's what makes open source special — but don't get ahead of yourself and submit a pull request for a new feature or idea.

For example, if you want to add a keyword, don't make additions lexer/parser then submit a PR, because you might waste your time if we don't accept the feature.

Instead, submit an issue explaining what the idea is, why you think it's a good fit, and how you came up with it.

If we like the idea, we'll either implement it ourselves or ask you to do so.

The decision isn't always polar though — it's not always an absolute yes or no — we may like part of the idea, but request some changes.

Pick an issue or suggest a feature

Pick an issue at the GitHub issues tab. I recommend you search for these tags if you are a beginner:

  • good first issue: Perfect for beginners
  • bug: A bit harder than good first issue, but still doable
  • help wanted: A bug fix/feature needing the community's suggestions
  • documentation: Documenting the code or improving the README

If there's a feature you want to add that's not in the issues, open an issue first.

Understanding the compiler design

The compiler's pipeline is built as:

flowchart LR

Lexer -->|Tokens| Parser -->|AST| Resolver -->|Symbol table| IR["Import Resolver"] --> TC["Type Checker"] --> CFG --> LLVMIR["LLVM IR"] --> |Object File| Linker --> Executable
Loading

Check out DESIGN.md for more info.

Workflow

  1. Fork the repo

  2. Create a new branch for your feature/fix with:

    git checkout -b feat/finnish-aliases

    The prefix of the branch may only be fix or feat

  3. Write your changes while following Go's coding style

  4. Write a test suite for the feature and run the tests with go test -v ./...

  5. Run go fmt ./... in the project root

  6. Write a commit message covering what you've changed, added or fixed. Example:

    git commit -m "added finnish aliases"

  7. Push your fork and create a new pull-request to dev. (Note: attempting to merge with main will close your PR). Describe the changes you have made to the codebase clearly. You can use keywords to close an issue (example Closes #10) If the CI fails on the tests, please review your code and fix it.

    Tips: You may also try out the feature or the compiler itself with a test.ks file.

Want help?

Open a Q&A issue if you need any help!