update documentation for contributions, remove private address

Add a HACKING doc for potential contributors.

All work for this project has always been public, so lets not
hold ourselves accountable for protecting others' anonymity or
privacy.  Instead, allow and encourage anonymity tools to be
used.

5 files changed, 45 insertions, 7 deletions

diff --git a/.document b/.document
index be86662..6d4a537 100644
--- a/.document
+++ b/.document
@@ -1,5 +1,6 @@
 LICENSE
 README
 NEWS
+HACKING
 lib
 ext/kcar/kcar.c
diff --git a/.olddoc.yml b/.olddoc.yml
index 86a5691..8b80f7f 100644
--- a/.olddoc.yml
+++ b/.olddoc.yml
@@ -3,5 +3,4 @@ cgit_url: https://bogomips.org/kcar.git
 git_url: git://bogomips.org/kcar.git
 rdoc_url: https://bogomips.org/kcar/
 ml_url: https://bogomips.org/kcar-public/
-private_email: kcar@bogomips.org
 public_email: kcar-public@bogomips.org
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..d3d54f8
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,37 @@
+== development dependencies
+
+* GNU make - https://www.gnu.org/software/make/
+* git - https://www.git-scm.com/
+* ruby - https://www.ruby-lang.org/en/
+
+        git clone git://bogomips.org/kcar
+
+== tests
+
+* make test - run each test in a separate process (parallelize using -j)
+
+For non-GNU users, GNU make may be installed as "gmake".
+
+== test environment
+
+N - specify the number of threads for *-mt targets (minitest parallelize_me!)
+RUBY - specify an alternative ruby(1) runtime
+V - set to 1 for verbose test output (may be mangled if multithreaded)
+
+== installing from git
+
+* make install-gem
+
+== contact
+
+We use git(7) and develop kcar on a public mailing list like git.git
+developers do.  Please send patches via git-send-email(1) to the public
+mailing list at <mailto:kcar-public@bogomips.org>.  Pull requests should be
+formatted using git-request-pull(1).
+
+All mail is archived publically at: https://bogomips.org/kcar-public/
+and nntp://news.public-inbox.org/inbox.comp.lang.ruby.kcar
+
+Anonymous contributions will always be welcome.
+No subscription is necessary to post to the mailing list.
+Please remember to Cc: all recipients as subscription is optional.
diff --git a/README b/README
index 85a9972..c735a76 100644
--- a/README
+++ b/README
@@ -83,8 +83,9 @@ don't email the git mailing list or maintainer with kcar patches.
 == Contact
 
 All feedback (bug reports, user/development discussion, patches, pull
-requests) go to the mailing list: mailto:kcar-public@bogomips.org
-
-Mailing list archives are available here:
-
-https://bogomips.org/kcar-public/
+requests) go to the public mailing list: mailto:kcar-public@bogomips.org
+All mail is archived publically at: https://bogomips.org/kcar-public/
+and nntp://news.public-inbox.org/inbox.comp.lang.ruby.kcar
+Anonymous requests will always be welcome.
+No subscription is necessary to post to the mailing list.
+Please remember to Cc: all recipients as subscription is optional.
diff --git a/kcar.gemspec b/kcar.gemspec
index 3d8d39d..ebabf06 100644
--- a/kcar.gemspec
+++ b/kcar.gemspec
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.homepage = Olddoc.config['rdoc_url']
   s.authors = ["kcar hackers"]
   s.description = readme_description
-  s.email = %q{kcar@bogomips.org}
+  s.email = %q{kcar-public@bogomips.org}
   s.extra_rdoc_files = extra_rdoc_files(manifest)
   s.files = manifest
   s.summary = summary