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
- Search existing issues.
- Name the phone, Android version, SoC/GPU, RAM and graphics route.
- Quote exact, relevant output rather than paraphrasing it.
- Remove usernames, licence keys, API tokens, Wi-Fi details and project secrets.
- Explain what you expected and what actually happened.
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:
- Measured: produced by a named command or repeatable test.
- Observed: a first-hand result such as “this Blender sample felt smooth.”
- Inferred: a conclusion supported by architecture or related evidence.
- Planned: a Pro design target that has not completed validation.
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:
- Device compatibility and OEM limitations
- Renderer, audio and session troubleshooting
- Safe daily operation and backup advice
- Reproducible Blender or local-AI findings
- Responsible development-agent guidance
- Authorised, defensive security-lab guidance with clear Android/PRoot limits
- English/Bangla parity and accessibility improvements
Out of scope for the public repository:
- The complete Pro installation procedure or proprietary modules
- Live licence/download endpoints before official release
- Real credentials, wallet addresses, customer support bundles or private logs
- Unauthorised intrusion instructions or real-world targets
- Claims that third-party services are permanently or universally free
Writing style
- Use plain language and short paragraphs.
- Explain the limitation with the capability.
- Separate a tested result from a recommendation.
- Keep security examples defensive and permission-based.
- Use loopback in service examples unless network exposure is the subject.
- Keep English and Bangla pages aligned in the same change when practical.
- Wrap Markdown prose at roughly 80 columns.
Internal links use .md in repository Markdown and are rewritten to .html by
GitHub Pages.
Checking a change
Before submitting:
- Confirm YAML front matter has matching
langandalt_urlvalues. - Check code fences and HTML tags are balanced.
- Test internal links and heading anchors.
- Search the diff for secrets and personal data.
- Confirm public wording does not expose a private Pro implementation detail.
- Preview both desktop and narrow mobile layouts when changing HTML/CSS.
Commits and pull requests
- Keep one clear intent per commit.
- Explain why the change is needed.
- State what was tested, on which device and how.
- Include before/after evidence for behaviour claims.
- Never commit a secret. If one is pasted into any public channel, revoke it; deleting the message or rewriting Git history is not enough.
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