CONTRIBUTING.md

May 6, 2025 · View on GitHub

The meaning of "open-source"

Our open source projects have publicly available code and other resources. This means that you are free to read and use it as you see fit under the terms of the license (usually Apache 2.0).

This simple fact is often misunderstood, so let us be crystal clear about what open source does not automatically mean by default:

  • It does not mean open to contributions;
  • It does not mean support is offered;
  • It does not mean you’re entitled to feature requests;
  • It does not mean the developer owes you their time;
  • It does not mean you’re entitled to anything;
  • It does not mean it is free and open-source (FOSS).

You can read more about this POV in this article.

Important


If you use any kind of LLM (AI models) for your contribution (code, tests, issues, questions, feature requests), you MUST check everything you can get out of it. If we find that your contribution is useless AI slop, you will be permanently banned from accessing to our GitHub organization.

Issues

  1. Provide product version where the problem was found;
  2. Provide info about your environment;
  3. Provide detailed info about your problem;
  4. Provide steps to reproduce the problem;
  5. Provide actual and expected results.

Code

  1. Check your code before creating pull request;
  2. If tests are present in a project, add tests for your code;
  3. Add inline documentation for your code;
  4. Apply code style used throughout the project;
  5. Create your pull request to develop branch (pull requests to other branches are not allowed).

Screenshots for README

  • Format — PNG optimized with TinyPNG;
  • Width — 888px or 1776px (x2);
  • Maximum size — 1MB.

Usage demo for README

  • Console size — 133 ⨯ 33;
  • Format — GIF optimized with EZGif;
  • Size — 1332px ⨯ 812px;
  • FPS — 12 or 24;
  • Maximum size — 3MB.