Skip to content

Latest commit

 

History

History
40 lines (35 loc) · 2.06 KB

File metadata and controls

40 lines (35 loc) · 2.06 KB

AI-Generated Content Policy

AI usage is not permitted for contributions to this repository. This includes (but is not limited to):

  • Generating code snippets, functions, classes, or entire files using AI tools (ChatGPT, Claude, Copilot, Grok, Gemini, etc.)
  • Using AI to write or significantly modify logic, algorithms, or implementation details

What is allowed:

  • Using AI only for grammar, spelling, and minor wording improvements in documentation, comments, or docstrings
  • Running AI tools locally for personal learning or experimentation (as long as the final contribution is written by you)

All contributions must be your own original work. If i suspect a contribution was primarily generated by AI (beyond minor text polishing), it may be rejected. I appreciate human creativity and thoughtful contributions. Thank you for respecting this policy.

Pull Request (PR) Information

  • Feel free to submit bug fixes for issues in the code:
    • If you're unsure how to resolve an issue, seek assistance with the code you're working on.
    • If you cannot seek help for an issue found in the source code, create an issue on the repository.
  • For contributions beyond bug fixes, please contact me on Discord first: MAX (ltzmax).
    • If you're unable to reach me on Discord, create an issue, and we can discuss it there.
  • If you have an idea for a new feature, please create an issue or contact me on Discord:
    • I welcome innovative ideas, but I may not accept all suggestions. Please create an issue or discuss with me on Discord to confirm alignment with the project.

Guidelines for Submitting PRs

Always use the following:

  • Ruff

How to Use Ruff

  • First, install Ruff:
pip install ruff
  • Then run the linter (fixes imports, style, and common issues automatically):
ruff check --fix <source_file_or_directory>
  • Then run the formatter:
ruff format <source_file_or_directory>

Both commands must be run before submitting a PR. Ruff is configured in pyproject.toml at the root of the repo — no extra flags needed beyond what's shown above.