Skip to content

Latest commit

 

History

History
22 lines (12 loc) · 1.34 KB

File metadata and controls

22 lines (12 loc) · 1.34 KB

Thanks for considering contributing to BaKGL. I'm always interested in seeing PRs from contributors.

Here's a few guidelines to make that quicker.

I have my own roadmap for what features I will work on. If you'd like to contribute, please get in touch first. Large changes made without discussion are unlikely to be accepted.

  1. Follow the existing code-style

There's plenty of existing code around so the style should be clear. Please avoid large style refactors, if you do want to do any, please do it in an isolated PR. Keep code comments short and succinct unless explaining original game behaviour, no multiline comments explaining why workarounds exist. That's what commit messages are for.

  1. Keep pull requests to a reasonable size

Large pull requests are hard to review. On the flip-side, many small PRs waste reviewer's time. Please keep PRs focused on related changes.

  1. No "Co-Authored by " lines in commit messages

Humans are responsible for the code written in this repo. You're welcome to use GenAI tools during development (I do :) ), but I expect that you, the human, have reviewed and understand any code before you open a PR.

  1. Do not use AI to communicate.

Other than for translation, I'd rather not read AI generated messages. This is my hobby and I appreciate talking to other humans who are passionate about Betrayal at Krondor.