~captainepoch/husky-man

90748d83dbdb39e9cdcd9799468bf2cf92d0dcd4 — Adolfo Santiago 3 months ago 1862798
Added ACRA reporting section
1 files changed, 24 insertions(+), 4 deletions(-)

M contributing.md
M contributing.md => contributing.md +24 -4
@@ 13,18 13,23 @@ Please keep reading to start hacking into the Husky project.
# Privacy policy

The emails sent to any mailist of the project will be public. Therefore, when
you send a patchset, the email you use will be seen by everyone subscribed to
the mailists and also to whoever accesses them.
you send a patchset or a bug report, the email you use will be seen by everyone
subscribed to the mailists and also to whoever accesses them.

The only emails that will be deleted from the mailist will be those not related
to the project whatsoever. Emails that were sent to contribute to a discussion
of something will be kept since they provide part of the whole context of the
discussion.

You also have an email address at your disposal in case you do not want to
expose your email to the public. If you have something to report or send, please
use the address `husky (at) nixnetmail (dot) com`. Please, **use plain-text
email**. HTML emails will be deleted. More information in the next section.

# Sending emails

Emails will be only admited if sent as plain text. HTML emails are automatically
rejected and don't even reach the mailist.
rejected and do not even reach the mailist.

Please follow the recommendations at [useplaintext.email][useplaintextemail].



@@ 115,6 120,19 @@ reproduce the bug as close as you encountered.
**NOTE: We never ask for the email or the password of the account. If anyone
asks you for that information, do not give it away!**.

## ACRA support

Since [Husky 1.1.0-beta1][husky-1.1.0-beta1] has ACRA support. This is an
**opt-in** feature, you must enable it in the Preferences view.

ACRA will only report crashes not controlled whithin the application. You can
see in the code the parameteres sent in the crash looking at
[TuskyApplication.kt#132-138][acra-config-report].

Emails will be sent to `husky (at) nixnetmail (dot) com`. No personal
information will not be made public, only the body of the email (if it contains
something useful) and the file attached to the email with the report.

# Security issues

If you find any security issues in any project related to Husky, please send an


@@ 129,9 147,11 @@ mailist.
It would be nice if you send also a patchset fixing the issue. And, of course,
all credit goes to you!


[acra-config-report]:
https://git.sr.ht/~captainepoch/husky/tree/master/item/husky/app/src/main/java/com/keylesspalace/tusky/TuskyApplication.kt#L132-138
[email-bug-template]: template_email_bug_report.md
[git-send-email]: https://git-send-email.io
[husky-1.1.0-beta1]: https://git.sr.ht/~captainepoch/husky/refs/1.1.0-beta1
[lists_husky_announce]: https://lists.sr.ht/~captainepoch/husky-announce
[lists_husky_devel]: https://lists.sr.ht/~captainepoch/husky-devel
[lists_sr_ht_email_control]: https://man.sr.ht/lists.sr.ht/#email-controls