diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2fcce51..8e7209d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,82 @@ -# Issues - Rules +# Issues +## Warnung +Before opening Issue, if it is more question than problem or bug - ask about that [in our chat](https://t.me/telemtrs) + ## What it is not - NOT Question and Answer - NOT Helpdesk -# Pull Requests - Rules +***Each of your Issues triggers attempts to reproduce problems and analyze them, which are done manually by people*** + +--- + +# Pull Requests + ## General - ONLY signed and verified commits - ONLY from your name -- DO NOT commit with `codex` or `claude` as author/commiter +- DO NOT commit with `codex`, `claude`, or other AI tools as author/committer - PREFER `flow` branch for development, not `main` -## AI -We are not against modern tools, like AI, where you act as a principal or architect, but we consider it important: +--- -- you really understand what you're doing -- you understand the relationships and dependencies of the components being modified -- you understand the architecture of Telegram MTProto, MTProxy, Middle-End KDF at least generically -- you DO NOT commit for the sake of commits, but to help the community, core-developers and ordinary users +## Definition of Ready (MANDATORY) + +A Pull Request WILL be ignored or closed if: + +- it does NOT build +- it does NOT pass tests +- it does NOT follow formatting rules +- it contains unrelated or excessive changes +- the author cannot clearly explain the change + +--- + +## Blessed Principles +- PR must build +- PR must pass tests +- PR must be understood by author + +--- + +## AI Usage Policy + +AI tools (Claude, ChatGPT, Codex, DeepSeek, etc.) are allowed as **assistants**, NOT as decision-makers. + +By submitting a PR, you confirm that: + +- you fully understand the code you submit +- you verified correctness manually +- you reviewed architecture and dependencies +- you take full responsibility for the change + +AI-generated code is treated as **draft** and must be validated like any other external contribution. + +PRs that look like unverified AI dumps WILL be closed + +--- + +## Maintainer Policy + +Maintainers reserve the right to: + +- close PRs that do not meet basic quality requirements +- request explanations before review +- ignore low-effort contributions + +Respect the reviewers time + +--- + +## Enforcement + +Pull Requests that violate project standards may be closed without review. + +This includes (but is not limited to): + +- non-building code +- failing tests +- unverified or low-effort changes +- inability to explain the change + +These actions follow the Code of Conduct and are intended to preserve signal, quality, and Telemt's integrity \ No newline at end of file diff --git a/README.md b/README.md index 5980885..8377730 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ***Löst Probleme, bevor andere überhaupt wissen, dass sie existieren*** / ***It solves problems before others even realize they exist*** +[**Telemt Chat in Telegram**](https://t.me/telemtrs) + **Telemt** is a fast, secure, and feature-rich server written in Rust: it fully implements the official Telegram proxy algo and adds many production-ready improvements such as: - [ME Pool + Reader/Writer + Registry + Refill + Adaptive Floor + Trio-State + Generation Lifecycle](https://github.com/telemt/telemt/blob/main/docs/model/MODEL.en.md) - [Full-covered API w/ management](https://github.com/telemt/telemt/blob/main/docs/API.md) @@ -9,60 +11,6 @@ - Prometheus-format Metrics - TLS-Fronting and TCP-Splicing for masking from "prying" eyes -[**Telemt Chat in Telegram**](https://t.me/telemtrs) - -## NEWS and EMERGENCY -### ✈️ Telemt 3 is released! - - - - - -
- -### 🇷🇺 RU - -#### О релизах - -[3.3.27](https://github.com/telemt/telemt/releases/tag/3.3.27) даёт баланс стабильности и передового функционала, а так же последние исправления по безопасности и багам - -Будем рады вашему фидбеку и предложениям по улучшению — особенно в части **API**, **статистики**, **UX** - ---- - -Если у вас есть компетенции в: - -- Асинхронных сетевых приложениях -- Анализе трафика -- Реверс-инжиниринге -- Сетевых расследованиях - -Мы открыты к архитектурным предложениям, идеям и pull requests - - -### 🇬🇧 EN - -#### About releases - -[3.3.27](https://github.com/telemt/telemt/releases/tag/3.3.27) provides a balance of stability and advanced functionality, as well as the latest security and bug fixes - -We are looking forward to your feedback and improvement proposals — especially regarding **API**, **statistics**, **UX** - ---- - -If you have expertise in: - -- Asynchronous network applications -- Traffic analysis -- Reverse engineering -- Network forensics - -We welcome ideas, architectural feedback, and pull requests. -
- -# Features -💥 The configuration structure has changed since version 1.1.0.0. change it in your environment! - ⚓ Our implementation of **TLS-fronting** is one of the most deeply debugged, focused, advanced and *almost* **"behaviorally consistent to real"**: we are confident we have it right - [see evidence on our validation and traces](#recognizability-for-dpi-and-crawler) ⚓ Our ***Middle-End Pool*** is fastest by design in standard scenarios, compared to other implementations of connecting to the Middle-End Proxy: non dramatically, but usual