ChameleonUltra/CONTRIBUTING.md

Chameleon Ultra Contribution guidelines

Any and all contributions are welcome!

Heres a bit of info and a few guidelines to get you started:

• General

  • Avoid force pushes. Force pushes and "one commit" PRs not only make reviewing more annoying but also erase a significant part of the git history. This, among other things, makes future debugging and bisection a lot harder.
  • Conventional commits. It is recommended to follow the conventional commit pattern when it comes to commit messages. While this is not strictly enforced, its highly recommended and a good habbit.
  • Atomic PRs. To help keep an overview and avoid conflicts, it is highly encouraged to file Atomic PRs. Atomic PRs are:
    • Focused Scope: It targets a single, well-defined change, making it easier to understand and review.
    • Minimal Size: It contains only the necessary code modifications to achieve its goal, avoiding unrelated changes.
    • Independent: It should be able to stand on its own without depending on other unmerged PRs, reviewed, and merged independently.
    • Self-Tested: each PR should include an appropriate set of unit tests that tests the changes. (optional but highly appreciated)
  • Atomic Commits. Similar thing as atomic PRs. When you are done with a feature, commit. Made a working change? commit. Git commits are basically free. Doing frequent commits at sensible points throughout development not only helps you keep track of progress but also saves progress and changes so you can revert when something goes wrong. It also helps when debugging and bisecting as more granular commits allow for easier issue location.

• CLI

  • The recommended packagemanager is UV (from astralsh). You may use the manager of your choice, but when adding new dependencies they must be added to the UV lock file and pyproject toml as well.
  • Type safety is important. The CLI should be typesafe. Python 3.9+ offer a wide variety of type declarations. Metas pyrefly is used to do type validation. It is recommended to install the appropriate vscode extension and check your types before opening a PR.
  • Formatting matters. Mostly. While pixelpeeping and exact rules are annoying and unnescesary, format your code in a readable and logical way. Ruff is used to enforce various formatting rules. You may install the Ruff vscode extension or use the CLI to format before opening a PR.
  • Avoid extra packages. Almost everyone knows the "meme" of the javascript "is-even" package. While it is encouraged and makes sense to use packages where appropriate, just installing packages for the hell of it even if its a 2 liner is not sensible.