Contributing Guidelines

April 16, 2026 · View on GitHub

  • Be kind and understanding.
  • It’s a good idea to create an issue before you start coding. This prevents disappointment if your pull request gets rejected.
  • Adhere to coding standards.
  • Keep commits small. Prevent making unrelated changes.

Language

Use English. I probably don’t understand your primary language, and you probably don’t understand mine. English is the middle ground that most people understand to some extent. This is also useful if a third party wants to help out.

Tests

I try to add tests and achieve 100% code coverage for all of my projects. Some projects are harder to test than others. I’m always open to suggestions on how a project could be tested.

Code Quality Tools

Most of my projects use linters and formatters to ensure a strict coding standard. Typically these tools are ESLint, Prettier, remark, and TypeScript, but they may vary per project. GitHub actions are used to verify the code adheres to these tools.

Gitignore

Don’t commit files that are related to your local development environment such as editor or operating system files. It is your responsibility to not commit them. It helps to configure a global gitignore. For reference have a look at my global gitignore.

Commit Messages

I recommend to use an imperative commit message title starting with an upper case character and to include a body, but I don’t enforce a commit message standard for my own projects.

LLM Usage

Many people use LLMs (often called AI) to assist in their programming to varying degrees. If you use an LLM to make changes, that’s ok. Just be honest about it up-front. You are responsible for the changes you submit and I expect you to understand them.

If I suspect you are a bot, I will close your issue or PR and if needed, I will report it as spam. If you turn out to be a misunderstood human, I’m sorry in advance. I want to be nice, but I have to be blunt to deal with LLMs.

Financial Support

My open source work is 100% free. However, life is not. If you like my work, consider sponsoring me via GitHub sponsors.