ISSUES: add section for bugs in other projects
[unicorn.git] / ISSUES
blob8910180f717c482b19e9540b22bf11d49f677f31
1 = Issues
3 mailto:unicorn-public@bogomips.org is the best place to report bugs,
4 submit patches and/or obtain support after you have searched the
5 {email archives}[http://bogomips.org/unicorn-public/] and
6 {documentation}[http://unicorn.bogomips.org/].
8 * No subscription will ever be required to email the public inbox.
9 * Cc: all participants in a thread or commit, as subscription is optional
10 * Do not {top post}[http://catb.org/jargon/html/T/top-post.html] in replies
11 * Quote as little as possible of the message you're replying to
12 * Do not send HTML mail, it will likely be flagged as spam
14 If your issue is of a sensitive nature or you're just shy in public,
15 then feel free to email us privately at mailto:unicorn@bogomips.org
16 instead and your issue will be handled discreetly.
18 If you don't get a response within a few days, we may have forgotten
19 about it so feel free to ask again.
21 == Bugs in related projects
23 unicorn is sometimes affected by bugs in its dependencies.  Bugs
24 triggered by unicorn in mainline Ruby, rack, GNU C library (glibc),
25 or the Linux kernel will be reported upstream and fixed.
27 For bugs in Ruby itself, we may forward bugs to
28 https://bugs.ruby-lang.org/ and discuss+fix them on the ruby-core
29 list at mailto:ruby-core@ruby-lang.org
30 Subscription to post is required to ruby-core, unfortunately:
31 mailto:ruby-core-request@ruby-lang.org?subject=subscribe
33 For uncommon bugs in Rack, we may forward bugs to
34 mailto:rack-devel@googlegroups.com and discuss there.
35 Subscription (without any web UI or Google account) is possible via:
36 mailto:rack-devel+subscribe@googlegroups.com
37 Note: not everyone can use the proprietary bug tracker used by Rack,
38 but their mailing list remains operational.
40 Uncommon bugs we encounter in the Linux kernel should be Cc:-ed to the
41 Linux kernel mailing list (LKML) at mailto:linux-kernel@vger.kernel.org
42 and subsystem maintainers such as mailto:netdev@vger.kernel.org
43 (for networking issues).  It is expected practice to Cc: anybody
44 involved with any problematic commits (including those in the
45 Signed-off-by: and other trailer lines).  No subscription is necessary,
46 and the our mailing list follows the same conventions as LKML for
47 interopability.  There is a kernel.org Bugzilla instance, but it is
48 ignored by most developers.
50 Likewise for any rare glibc bugs we might encounter, we should Cc:
51 mailto:libc-alpha@sourceware.org
52 Keep in mind glibc upstream does use Bugzilla for tracking bugs:
53 https://sourceware.org/bugzilla/
55 == Submitting Patches
57 See the HACKING document (and additionally, the
58 {SubmittingPatches}[https://git.kernel.org/cgit/git/git.git/tree/Documentation/SubmittingPatches]
59 document distributed with git) on guidelines for patch submission.
61 == Contact Info
63 * public: mailto:unicorn-public@bogomips.org
64 * private: mailto:unicorn@bogomips.org
66 We operate a {public-inbox}[http://public-inbox.org/] which
67 feeds the mailing list.  You may subscribe either using
68 {ssoma}[http://ssoma.public-inbox.org/] or by sending a mail
69 to mailto:unicorn-public+subscribe@bogomips.org
71 ssoma is a mail archiver/fetcher using git.  It operates in a similar
72 fashion to tools such as slrnpull, fetchmail, or getmail.  ssoma
73 subscription instructions:
75         URL=git://bogomips.org/unicorn-public
76         LISTNAME=unicorn
78         # to initialize a maildir (this may be a new or existing maildir,
79         # ssoma will not touch existing messages)
80         # If you prefer mbox, use mbox:/path/to/mbox as the last argument
81         # You may also use imap://$MAILSERVER/INBOX for an IMAP account
82         # or imaps:// for an IMAPS account, as well.
83         ssoma add $LISTNAME $URL maildir:/path/to/maildir
85         # read with your favorite MUA (only using mutt as an example)
86         mutt -f /path/to/maildir # (or /path/to/mbox)
88         # to keep your mbox or maildir up-to-date, periodically run the following:
89         ssoma sync $LISTNAME
91         # your MUA may modify and delete messages from the maildir or mbox,
92         # this does not affect ssoma functionality at all
94         # to sync all your ssoma subscriptions
95         ssoma sync
97         # You may wish to sync in your cronjob
98         ssoma sync --cron
100 HTML archives are available here: http://bogomips.org/unicorn-public/