]> Sergey Matveev's repositories - public-inbox.git/blobdiff - HACKING
v2writable: move git->cleanup to the correct place
[public-inbox.git] / HACKING
diff --git a/HACKING b/HACKING
index a766820957f89748ebd4522efdd9c55a6a94eaff..666d504e7336b61ef7d26f559e5b192c56fbd9de 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,8 +1,14 @@
 hacking public-inbox
 --------------------
 
-Send all patches via to our self-hosting inbox at meta@public-inbox.org
-It is archived at <http://public-inbox.org/meta/>.
+Send all patches and "git request-pull"-formatted emails to our
+self-hosting inbox at meta@public-inbox.org
+It is archived at: https://public-inbox.org/meta/
+and http://hjrcffqmbrq6wope.onion/meta/ (using Tor)
+
+Contributions are email-driven, just like contributing to git
+itself or the Linux kernel; however anonymous and pseudonymous
+contributions will always be welcome.
 
 Please consider our goals in mind:
 
@@ -24,18 +30,31 @@ This includes folks on slow connections and ancient browsers which
 may be too difficult to upgrade due to resource demands.
 
 Only depend on Free Software packages which exist in the "main"
-section of Debian 7.0 and later.  (We will bump version requirements
-as time passes, but this is current as of January 2016).
+section of Debian "stable" distribution.  That is Debian 9.x
+("stretch") as of this writing, but "oldstable" (8.x, "jessie")
+remains supported for v1 repositories.
+
 In general, we favor mature and well-tested old things rather than
 the shiny new.
 
 Avoid relying on compiled modules too much.  Even if it is Free,
-compiled code makes packages more expensive to audit, build, and
+compiled code makes packages more expensive to audit, build,
 distribute and verify.  public-inbox itself will only be implemented
-in scripting languages (currently Perl 5).
+in scripting languages (currently Perl 5) and optional JIT-compiled C
+(via Inline::C)
 
 Performance should be reasonably good for server administrators, too,
 and we will sacrifice features to achieve predictable performance.
+Encouraging folks to self-host will be easier with lower hardware
+requirements.
+
+See design_www.txt and design_notes.txt in the Documentation/
+directory for design decisions made during development.
+
+Perl notes
+----------
 
-See design_www.txt and design_notes.txt in the Documentation/ directory
-for design decisions made during development.
+* \w, \s, \d character classes all match Unicode characters;
+  so write out class ranges (e.g "[0-9]") if you only intend to
+  match ASCII.  Do not use the "/a" (ASCII) modifier, that requires
+  Perl 5.14 and we're only depending on 5.10.1 at the moment.