Contributing
September 7, 2026 · View on GitHub
Thanks for contributing to Titanium Web Proxy.
Editions
| Paths | License | External PRs |
|---|---|---|
src/Titanium.Web.Proxy/, src/Titanium.Web.Proxy.Abstractions/, src/Titanium.Web.Proxy.Configuration/, src/Titanium.Cli/, related MIT tests/examples/tools/docs, website/ | MIT | Welcome after CLA |
src/Titanium.Plus/, src/Titanium.Inspector/, tests/Titanium.Plus.Tests/, tests/Titanium.Inspector.Tests/ | PolyForm Noncommercial | Maintainer allowlist only |
See CLA.md and README.md Editions section.
Before you open a PR
- Sign the CLA if you have not already.
- Target the
developbranch (unless a maintainer directs otherwise). - Run
dotnet build src/Titanium.Web.Proxy.sln -c Releaseanddotnet testfor affected test projects. - Do not introduce third-party product names of other proxies or traffic debuggers into source, tests, CLI help, or docs.
- Keep hot-path changes minimal; preserve
ForwardHostterminate-lite eligibility when routes are unset or equivalent to a single sticky destination.
Local QA tooling (maintainers)
Not for end users. Per-OS checklists and on-demand probes live under tools/:
- LOCAL-QA.md — solo checklist (E2E + probes)
- CliQaProbe — CLI help / dialects / live
run/ optional OS service - InspectorDesktopProbe — system proxy / CA / browser UX
- RpsLoadProbe — concurrent breaking-point load in requests per second (RPS)
PR checklist
Use the pull request template. Include tests for behavior changes. Do not weaken performance gates or skip PublicAPI analyzer updates for intentional API surface changes.
Code owners
PolyForm Noncommercial paths are owned by @justcoding121. See .github/CODEOWNERS.