This project is archived. Its data is
read-only
.
Changes
Page history
Apply conversion script to all *.md files.
authored
Jun 15, 2020
by
Alexander Hansen Færøy
Show whitespace changes
Inline
Side-by-side
doc/PluggableTransports/GuidelinesForDeployingPTs.md
View page @
a1a4b621
==
PT Criteria
==
##
PT Criteria
===
Things we need:
===
###
Things we need:
-
TODO: One set of criteria for what a good pluggable transport should be.
-
TODO: One set of criteria for what a good pluggable transport should be.
-
TODO: One set of criteria for getting a PT into the Tor Browser Bundle.
-
TODO: One set of criteria for getting a PT into the Tor Browser Bundle.
===
Existing Documents:
===
###
Existing Documents:
-
TICKET: Formalize and document what it takes for a PT to get deployed. https://trac.torproject.org/projects/tor/ticket/16756
-
TICKET: Formalize and document what it takes for a PT to get deployed. https://trac.torproject.org/projects/tor/ticket/16756
-
Pluggable Transport Evaluation Criteria https://trac.torproject.org/projects/tor/wiki/doc/PluggableTransports/PTEvaluationCriteria)
-
Pluggable Transport Evaluation Criteria https://trac.torproject.org/projects/tor/wiki/doc/PluggableTransports/PTEvaluationCriteria)
-
For historical reference, the FTE review and deployment process is documented in #10362.
-
For historical reference, the FTE review and deployment process is documented in #10362.
===
Before submitting a PT for inclusion into TBB a developer...
===
###
Before submitting a PT for inclusion into TBB a developer...
-
MUST be able to be built the PT deterministically
-
MUST be able to be built the PT deterministically
-
MUST have had the PT in TBB alpha for [X] period of time
-
MUST have had the PT in TBB alpha for [X] period of time
-
SHOULD build a patch for TBB and provide the patched TBB for review along with the PT for testing
-
SHOULD build a patch for TBB and provide the patched TBB for review along with the PT for testing
===
For inclusion into TBB a PT...
===
###
For inclusion into TBB a PT...
-
MUST offer a different feature than existing PT's.
-
MUST offer a different feature than existing PT's.
-
MUST have code that is well documented and maintainable by a party working without the support of the original developers
-
MUST have code that is well documented and maintainable by a party working without the support of the original developers
...
@@ -29,7 +29,7 @@
...
@@ -29,7 +29,7 @@
-
SHOULD have a well thought out deployment plan (e.g. plan for recruiting people who will run the specified PT on Tor Bridges)
-
SHOULD have a well thought out deployment plan (e.g. plan for recruiting people who will run the specified PT on Tor Bridges)
-
MUST be written in a reasonable language - e.g. MUMPS :) -
-
MUST be written in a reasonable language - e.g. MUMPS :) -
===
The Process for getting a PT included into TBB is to...
===
###
The Process for getting a PT included into TBB is to...
-
A0) DON'T email individual developers
-
A0) DON'T email individual developers
-
A1) Send an email to tor-dev or create a trac-ticket announcing your intent to create a PT
-
A1) Send an email to tor-dev or create a trac-ticket announcing your intent to create a PT
...
@@ -41,7 +41,7 @@
...
@@ -41,7 +41,7 @@
-
E) TODO: Changes from Alpha deployment here?
-
E) TODO: Changes from Alpha deployment here?
-
F) TODO: It is rolled out to TBB stable here?
-
F) TODO: It is rolled out to TBB stable here?
===
The things that we need to do to ensure that outside developers have the greatest chance of success are...
===
###
The things that we need to do to ensure that outside developers have the greatest chance of success are...
-
Create a website/page that tells you the steps involved in developing and deploying a PT
-
Create a website/page that tells you the steps involved in developing and deploying a PT
-
Create a way for devs to find the website (See: PT-vangelist)
-
Create a way for devs to find the website (See: PT-vangelist)
...
@@ -50,7 +50,7 @@
...
@@ -50,7 +50,7 @@
-
In the short term "If you are interested f!
**
k off... but, try the wiki."
-
In the short term "If you are interested f!
**
k off... but, try the wiki."
-
In the long term "Communicate that there is a team and steer people towards the mailing list because it is permanent and asynchronous."
-
In the long term "Communicate that there is a team and steer people towards the mailing list because it is permanent and asynchronous."
===
The process for removing a PT from TBB is
===
###
The process for removing a PT from TBB is
-
We need a process & criteria for evaluating when a PT will get removed from Tor.
-
We need a process & criteria for evaluating when a PT will get removed from Tor.
-
Drop a PT when it is broken? But it is rarely broken in all countries just because broken in one.
-
Drop a PT when it is broken? But it is rarely broken in all countries just because broken in one.
...
...
...
...