~captainepoch/husky-man

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

Therefore, in order to contribute to the project, you must setup git to send patches to the mailists.

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.

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.

#Sending emails

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

Please follow the recommendations at useplaintext.email.

It is encouraged to wrap emails at 72 chars (see Wrapping your text at useplaintext.email/#etiquette).

#Setting up git

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

After following the tutorial you will have a basic setup, which is enough to contribute to a 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 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"

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:

git config format.subjectPrefix "PATCH husky"

And then you can send the patchset you want to.

Patches send without this will be automatically rejected.

#Mailists

The project has two main mailists.

If you are not a Sourcehut user, please follow lists.sr.ht email control doc. 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.

#husky-devel

This list will be used for open discussion about issues and patchsets hackers send.

Anyone can send an email to this mailist. The discussions aim to be serious. Please restrain to send spam not about the project.

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

#Bug reports and TODOs

For reporting bugs and see the TODOs in the project, you can take a look at the tracker.

If you send a patch to the husky-devel mailist, please follow the instructions above and also indicate in the commit which bug/TODO you made, so it can be closed, otherwise the patchset will be discarded.

#Security issues

If you find any security issue in any project related to Husky, please send an email to me (epoch (at) nixnetmail (dot) com). After the fix I will write a mail informing the users. You will be kept informed about the progress of the fix.

It would be nice if you send also a patchset fixing the issue. And, of course, all credit goes to you!

About this wiki

commit 87ed9728c00664ddb34155a6ccb3961bec18be6e
Author: Adolfo Santiago <epoch@nixnetmail.com>
Date:   2021-08-30T18:02:48+02:00

Added bugtracker link, added more info
Clone this wiki
https://git.sr.ht/~captainepoch/husky-man (read-only)
git@git.sr.ht:~captainepoch/husky-man (read/write)