~ancarda/tls-redirector

ref: 5f0b9ad56965a4fa1f18e3734f574c80e6e7340f tls-redirector/CONTRIBUTING.md -rw-r--r-- 2.0 KiB
5f0b9ad5Mark Dain Add a basic Docker healthcheck 2 months ago

#Contributing Guide

Thanks for your interest in contributing to tls-redirector!

This guide assumes you are somewhat familiar with Git and have contributed to open source software beforehand.

If you are struggling with anything -- Git, Go, C, Docker, or anything else -- please don't hesitate to send an email to the mailing list (public) or the maintainer (private).

#Sending Patches

#Via Email

Email is the primary way to send patches to this project. If you are new to git send-email, the website https://git-send-email.io/ has a good intro. Once you have setup SMTP, you should run this command in the directory where you checked out this project:

git config sendemail.to "~ancarda/tls-redirector@lists.sr.ht"

You don't need to subscribe to the mailing list to participate.

#Via GitHub

If you are not able or willing to use git send-email, you can you can send patches via GitHub's "Pull Request" feature. The mirror can be forked and is monitored by the maintainer.

You will need a GitHub account and may need to run non-free JavaScript to send patches this way.

#Discussions

To discuss features or report bugs, send an email to the mailing list. The GitHub mirror cannot be used for issue tracking.

Please do not directly submit to the issue tracker.

Discussions that affect all ancarda projects can be sent to the Public Inbox.

And of course, any discussion that is better off-the-record - such as security reports - can be sent directly to the maintainer. Feel free to use PGP.