ternux /contributing
Write the code a careful stranger could read at 3am and still trust.
— Sobuj Miah

Contributing

This public repository contains the ternux website and public documentation. The most useful contributions are compatibility evidence, corrections, translations and reproducible workload observations.

Do not submit proprietary installer code, private Pro procedures, licence material, customer data or private endpoints here.


Before opening an issue

For graphics reports, the renderer string is more useful than “GPU works.” For workload reports, include app version, scene/model size, memory pressure, approximate session length and thermal state.


Evidence levels

Label claims honestly:

Do not turn one-device observations into universal promises. In particular, Blender, local-AI and benchmark results vary substantially by driver, workload, RAM and temperature.


Public documentation scope

Welcome additions include:

Out of scope for the public repository:


Writing style

Internal links use .md in repository Markdown and are rewritten to .html by GitHub Pages.


Checking a change

Before submitting:

  1. Confirm YAML front matter has matching lang and alt_url values.
  2. Check code fences and HTML tags are balanced.
  3. Test internal links and heading anchors.
  4. Search the diff for secrets and personal data.
  5. Confirm public wording does not expose a private Pro implementation detail.
  6. Preview both desktop and narrow mobile layouts when changing HTML/CSS.

Commits and pull requests


Reporting a security issue

Use GitHub Security Advisories for vulnerabilities, leaked private endpoints or credential-handling problems. Do not include an active secret unless the private reporting channel explicitly requires it; revoke exposed credentials first.


Licence

Public documentation contributions are accepted under the MIT Licence. Contributions do not grant access to, or change the licence of, ternux Pro and its private materials.


ternux — Copyright (c) 2026 Sobuj Miah (@soobujmiah) · MIT

Edit this page on GitHub → ↑ Back to top