Contributing #

TYSM for wanting to contribute to this silly little project of mine! There's only a few guidelines I'd like you to follow while you're around here :3.

Formatting #

Please make sure all code submitted is formatted correctly! If you use nix you can do nix fmt to format the entire repo.

Commit Convention #

Prefix any commit/PR messages/titles with the project/subproject's name.

Not too strict about the actual message as long as it describes the commit overall.

Examples #

Do: #

• stare: Custom type declaration
• lexgen: add more lexicon types
• docs: add CONTRIBUTING.md
• ci: added test runs for stare

Don't: #

• fixed bug
• add more lexicon types
• add CONTRIBUTING.md

Strict no-AI policy #

Adapted and extended from Zig's Policy.

Do not use AIs for any code, issues, patches/PRs, comments or assets (such as, but not limited to, images).

If you have been found to use AI in any submissions to the project you will be prohibited from contributing indefinitely.