kcar RubyGem user+dev discussion/patches/pulls/bugs/help
 help / color / mirror / code / Atom feed
From: Eric Wong <kcar-public@bogomips.org>
To: kcar-public@bogomips.org
Subject: [PATCH 1/6] update documentation for contributions, remove private address
Date: Sun,  5 Mar 2017 23:13:11 +0000	[thread overview]
Message-ID: <20170305231316.8645-2-kcar-public@bogomips.org> (raw)
In-Reply-To: <20170305231316.8645-1-kcar-public@bogomips.org>

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.
---
 .document    |  1 +
 .olddoc.yml  |  1 -
 HACKING      | 37 +++++++++++++++++++++++++++++++++++++
 README       | 11 ++++++-----
 kcar.gemspec |  2 +-
 5 files changed, 45 insertions(+), 7 deletions(-)
 create mode 100644 HACKING

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
-- 
EW


  reply	other threads:[~2017-03-05 23:13 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-03-05 23:13 [PATCH 0/6] more minor doc updates Eric Wong
2017-03-05 23:13 ` Eric Wong [this message]
2017-03-11 21:31   ` [PATCH] HACKING: remove copy+pasted line about N Eric Wong
2017-03-05 23:13 ` [PATCH 2/6] doc: minor updates to describe classes, better Eric Wong
2017-03-05 23:13 ` [PATCH 3/6] response: remove unnecessary constant alias Eric Wong
2017-03-05 23:13 ` [PATCH 4/6] response: more documentation cleanups Eric Wong
2017-03-05 23:13 ` [PATCH 5/6] favor require_relative to speed up loading Eric Wong
2017-03-05 23:13 ` [PATCH 6/6] response: remove Ruby 1.8-compatibility check Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://yhbt.net/kcar/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170305231316.8645-2-kcar-public@bogomips.org \
    --to=kcar-public@bogomips.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhbt.net/kcar.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).