~captainepoch/husky-man

ref: c861c03cb46d1ec9d1a7bf60bb9e4b448b2b81fe husky-man/contributing.md -rw-r--r-- 4.5 KiB
c861c03cAdolfo Santiago Added a notice about keeping the content uploaded 5 months ago

#title: Contributing to Husky

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

Please read this first to start contributing to the Husky project.

#Sending emails

Emails will be only admited if sent as plain text. Use english and capitalize your email properly. More at the [Common rules][common_rules] documentation.

Follow the recommendations at useplaintext.email.

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

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 sending patches, I cannot recommend enough git-send-email.io 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 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 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 all the patches you need.

Patches sent without this will be automatically rejected.

#todo list

NOTE: SourceHut will be the main platform for the development of Husky. Reports and/or feature requests done by email will be prioritized.

Husky has a main issue tracker that you can check going to the todo list.

Before sending any email reporting a bug or asking for a new feature, it is encouraged to take a look here first in case there is already an open ticket.

For people who do not want to send an email, there is an issue tracker at Codeberg. You can check this out at Husky/husky-issues.

Please check the Reporting bugs section for more information.

#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-devel

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

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.

#Security issues

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

If you happen to know how to fix the issue, patches are welcome!