~captainepoch/husky-man

bcc6454bc52bb747c5c6076b31ff61065576f2fe — Adolfo Santiago 17 days ago d63524b master
Update contributing doc.
1 files changed, 50 insertions(+), 49 deletions(-)

M contributing.md
M contributing.md => contributing.md +50 -49
@@ 3,47 3,37 @@ title: Contributing to Husky
---

This project will be managed with the same workflow as the rest or Sourcehut's
projects: using patches.
projects: using patches and emails.

Therefore, in order to contribute to the project, you must setup `git` to send
patches to the mailists.
patches to the mailists. Also you must setup your email client to send emails to
the mailist.

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 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.
Please read this first to start contributing to the Husky project.

# Sending emails

Emails will be only admited if sent as plain text. HTML emails are automatically
rejected and do not even reach the mailist.
Emails will be only admited if sent as plain text. Use english and
capitalize your email properly.

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

It is encouraged to wrap emails at 72 chars (see _Wrapping your text_
at [useplaintext.email/#etiquette][useplaintextemailetiquette]).

HTML emails and emails containing media attached are automatically
rejected and do not even reach the mailist. If you need to attach any media
files to the email, please upload those files to an external service and add the
link(s).

# Setting up git

If this is your first time, I cannot recommend enough
[git-send-email.io][git-send-email] to learn how to send patches using git +
email if you never did.
If this is your first time sending patches, I cannot recommend enough
[git-send-email.io][git-send-email] to learn how to send patches using
git + email.

After following the tutorial you will have a basic setup, which is enough to
contribute to a project.
contribute to the project.

However, there are a requirement for patches being acepted: setting up the
subject prefix of the email. This is made using this for each repository (so the


@@ 52,10 42,10 @@ configuration is local and not every email is sent with `PATCH foorbar`).
For each project you must execute this:

```
git config format.subjectPrefix "PATCH repository_name"
git config format.subjectPrefix "PATCH <repository_name>"
```

Where `repository_name` **is the name of the repository** you are working on.
Where `<repository_name>` **is the name of the repository** you are working on.

For example, if you want to contribute to the application (its repository is
named `husky`), first you have to execute inside your local copy:


@@ 64,10 54,20 @@ named `husky`), first you have to execute inside your local copy:
git config format.subjectPrefix "PATCH husky"
```

And then you can send the patchset you want to.
And then you can send all the patches you want.

Patches sent without this will be automatically rejected.

# Issue tracker a.k.a todo list

Husky has an issue tracker to keep pending tasks and reported bugs to be fixed.
You can take a look going to [todo][todo_husky].

Before sending any email is encouraged to take a look first here in case your
request (whether it's a feature request or a bug report) is already here.

If not, feel free to send an email!

# Mailists

The project has two main mailists.


@@ 75,44 75,44 @@ The project has two main mailists.
If you are not a Sourcehut user, please follow [lists.sr.ht email control
doc.][lists_sr_ht_email_control] to subscribe to the mailists.

## husky-announce

This list will be only to announce releases of the project or important news. It
will not be open to the public to send any emails. However, if you are a user of
the application, I recommend to subscribe, even if you are not a Sourcehut user.

You can access to the list at
[lists.sr.ht/~captainepoch/husky-announce][lists_husky_announce].

## husky-devel

This list will be used for open discussion about issues and patchsets hackers
send.
This list will be used for open discussion about features requests, bug reports
and patches.

Anyone can send an email to this mailist. The discussions aim to be serious.
Please restrain from sending spam not about the project.
Please restrain from sending spam or off-topic emails, or any email about any
other topic not related to the project.

You can access to the list at
[lists.sr.ht/~captainepoch/husky-devel][lists_husky_devel].

Patches must contain a brief comment about what it does, and if necessary, a
larger explanation along in the patch or in the email.
Patches must contain a brief comment about what they do.

## husky-announce

This list will be only to announce releases of the project or important news. It
will not be open to the public to send any emails. However, if you are a user of
the application, I recommend you to subscribe, even if you are not a Sourcehut
user.

You can access to the list at
[lists.sr.ht/~captainepoch/husky-announce][lists_husky_announce].

# Security issues

If you find any security issues in any project related to Husky, please send an
email to me (`epoch (at) nixnetmail (dot) com`) providing as much information
and context as possible (maybe the [bug reporting email
template][email-bug-template]) can be of help here.
If you find any security issues in Husky, please send an email to me
(`epoch (at) nixnetmail (dot) com`), providing as much information
and context as possible (maybe the
[bug reporting email template][email-bug-template] can be of help here).

After the fix is pushed into the repository, a version will be released and an
email will be sent explaining the bug and the fix to the `husky-announce`
mailist.

It would be nice if you send also a patchset fixing the issue. And, of course,
all credit goes to you!
If you happen to know how to fix the issue, patches are welcome!

# Bug reporting
# Reporting bugs

Please check [Reporting bugs][bugreport].



@@ 122,5 122,6 @@ Please check [Reporting bugs][bugreport].
[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
[todo_husky]: https://todo.sr.ht/~captainepoch/husky
[useplaintextemail]: https://useplaintext.email
[useplaintextemailetiquette]: https://useplaintext.email/#etiquette