~captainepoch/husky-man

a0a3defeceb9744f197b69411011ca77f605495e — Adolfo Santiago 2 months ago c861c03
Fix wording, rename document
5 files changed, 44 insertions(+), 26 deletions(-)

M contributing.md
M index.md
R bugreport.md => open_ticket.md
M rules_reports.md
M template_email_bug_report.md
M contributing.md => contributing.md +13 -11
@@ 3,14 3,14 @@ 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.
the mailists. Also, you must setup your email client to send emails to the
mailist properly formatted.

Please read this first to start contributing to the Husky project.
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
Emails will be only admited if sent as plaintext. Use english and capitalize
your email properly. More at the [_Common rules_][common_rules] documentation.

Follow the recommendations at [useplaintext.email][useplaintextemail].


@@ 59,23 59,24 @@ Patches sent without this will be automatically rejected.
**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
Husky has a main todo tracker that you can check going to the [todo
list][todo_husky].

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.
Before sending any email reporting a bug or requesting 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][codeberg_husky_issues].

Please check the [Reporting bugs][bugreport] section for more information.
Please check the [Open a ticket][open_ticket] documentation 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.][lists_sr_ht_email_control] to subscribe to the mailists.
If you are not a Sourcehut user, please follow [lists.sr.ht email
control][lists_sr_ht_email_control] documentation to subscribe to the mailists.

## husky-devel



@@ 114,13 115,14 @@ mailist.

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

[bugreport]: bugreport.md
[common_rules]: rules_reports.md
[codeberg_husky_issues]: https://codeberg.org/Husky/husky-issues/issues
[email_bug_template]: template_email_bug_report.md
[git_send_email]: https://git-send-email.io
[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
[open_ticket]: open_ticket.md
[todo_husky]: https://todo.sr.ht/~captainepoch/husky
[useplaintextemail]: https://useplaintext.email
[useplaintextemailetiquette]: https://useplaintext.email/#etiquette

M index.md => index.md +5 -5
@@ 4,7 4,7 @@ title: Husky man pages

This page contains the documentation for the [Husky project][husky_project].

## Initial version
## Initial version of the project

This is a clone of the [original project][husky].



@@ 23,13 23,13 @@ See [Contributing][contributing].

See [Building][building].

# Reporting bugs
# Reporting bugs, make feature requests and other

See [Reporting bugs][bugreport].
See [Open a ticket][open_ticket].

# Licenses

The project has two licenses, which can be seen following the links.
The project has two licenses.

## Documentation



@@ 45,7 45,6 @@ See [Husky license][husky_license].
The original maintainer of Husky is [a1ba][a1ba].

[a1ba]: https://expired.mentality.rip/a1ba
[bugreport]: bugreport.md
[building]: building.md
[contributing]: contributing.md
[copying]: https://git.sr.ht/~captainepoch/husky-man/tree/master/item/COPYING


@@ 54,6 53,7 @@ The original maintainer of Husky is [a1ba][a1ba].
[husky_last_commit]: https://git.mentality.rip/FWGS/Husky/commit/cf363059d3ecd4d073da48e3343e0b6e14ea8892
[husky_license]: https://git.sr.ht/~captainepoch/husky/tree/master/item/COPYING
[husky_project]: https://sr.ht/~captainepoch/husky
[open_ticket]: open_ticket.md
[privacy-policy]: privacy-policy.md
[tusky]: https://github.com/tuskyapp/Tusky
[tusky_license]: https://github.com/tuskyapp/Tusky/blob/develop/LICENSE.txt

R bugreport.md => open_ticket.md +17 -6
@@ 1,17 1,24 @@
---
title: Reporting bugs
title: Open a ticket
---

Bug reporting can be done in two ways. Please, read everything carefuly before
_NOTE: bug reports, feature requests and/or asking for support will be called
"ticket" or "tickets"._

There are two ways for opening a ticket. Read everything carefuly before
reporting anything.

Check the [_Common rules_][common_rules] documentation before reporting anything
at any platform.
Check the [_Common rules_][common_rules] documentation.

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

# Mailist

Bugs must be reported to the `husky-devel` mailist. The email addres to send any
email to that mailist is `~captainepoch/husky-devel@lists.sr.ht`.
Before opening a ticket it must be discussed over the development mailist. The
email addres to send any email to that mailist is
`~captainepoch/husky-devel@lists.sr.ht`. After discussing the problem, a ticket
will be opened at the [todo tracker][todo_husky].

If you need help to compose the bug report, a template is provided to help you
add all the information needed. You can take a look at [email


@@ 26,6 33,10 @@ For those who do not want to send an email, for any reason, there is an issue
tracker at Codeberg to report issues. You can take a look at
[Husky/husky-issues][husky_issues].

**Templates are mandatory**. Issues opened without following one of the provided
templates (the default one does not count) will be deleted.

[common_rules]: rules_reports.md
[email_bug_template]: template_email_bug_report.md
[husky_issues]: https://codeberg.org/Husky/husky-issues/issues
[todo_husky]: https://todo.sr.ht/~captainepoch/husky

M rules_reports.md => rules_reports.md +7 -4
@@ 23,16 23,19 @@ establish a few non-negotiable rules.

   Also, make sure that the content stays accesible in order to check it out
   later, as the maintainer or other contributors might take some time to be
   able to take a look.
   able to take a look. Do not delete the content you upload even if your bug
   report or question has been attended, context is important.

   You are solely responsible for the content you upload. Therefore, if the
   **You are solely responsible for the content you upload**. Therefore, if the
   content uploaded to an issue is not deemed compliant with the rules of the
   platform, your account may be reported.

3. **Respect others**: I do not know why I add this, but just in case, respect
   everyone and keep debates easy.
4. **Asking for an ETA**: If you ask for an ETA, the response is always the
   same: `soon(TM)`.

Not following those rules the todo task/ticket will be closed until it complies
with them.
Not following those rules will make that the todo task/ticket is closed until it
complies with them.

This rules are subject to change at any moment.

M template_email_bug_report.md => template_email_bug_report.md +2 -0
@@ 5,11 5,13 @@ Husky version:
Android version:

Instance where it happened:
Software running at the instance:

Steps to reproduce the bug (as many as needed):
1.
2.

Optional fields:

- Mobile vendor and model:
```