Contributing

magik-tools is a work in progress and currently developed in my spare time. I cannot guarantee this project is bug-free and/or will work according to your expectations. You can contribute by using this software and report results.

If you do find any problems, have suggestions, or otherwise, report these at the issue tracker. If you report an issue, please report what is happening, expected result, actual result, used versions, etc. Also, please don't create pull requests, and prefer creating issues.

AI-generated content

Pull request (please only use these when really needed, prefer issues instead) descriptions and replies in discussions must be written by you, not by an AI. This is to ensure that you, as the creator of the pull request, fully understand what you are making, and to prevent low-effort contributions. Using AI to generate code, improve comments, etc, is allowed, but you still have to be able to understand what was created.

Pull requests containing AI-generated text will either be ignored, or picked up with a very low priority.

It is okay to use an AI to make changes to code, or to have an AI perform analysis. However, you must still fully understand the changes you are proposing.

Contributor License Agreement

Before we can accept your contributions, you must sign our Contributor License Agreement. This is a one-time requirement.

To sign, add your name and GitHub username to the CLA-SIGNERS file and submit a pull request. A GitHub Actions check will verify your signature on all future PRs.

Again, please prefer creating issues instead of pull requests.