Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 1.64 KB

Contributing

This project's mailing list is ~gotmax23/[email protected] (archives).

Development, issue reporting, and project discussion happen on the mailing list.

Issue Reporting and Feature Requests

Direct these to the mailing list. tomcli has a ticket tracker on todo.sr.ht, but it's only for confirmed issues.

Patches

Contributions are always welcome! It is recommended that you send a message to the mailing list before working on a larger change.

Patches can be sent to ~gotmax23/[email protected] using git send-email. No Sourcehut account is required!

After configuring git-send-email as explained at git-send-email.io:

git clone https://git.sr.ht/~gotmax23/tomcli
cd tomcli

# First time only
git config sendemail.to "~gotmax23/[email protected]"
git config format.subjectprefix "PATCH tomcli"

$EDITOR ...

nox

git commit -a -v
git send-email origin/main

See git-send-email.io for more details.

If you prefer, git.sr.ht has a webui to help you submit patches to a mailing list that can be used in place of git send-email. You can follow this written guide or this video guide for how to use the webui.