From a9a4aac3229fccefaa4f3927814503cd60fc3ce4 Mon Sep 17 00:00:00 2001 From: Lorenz Leutgeb Date: Tue, 4 Feb 2025 15:07:10 +0100 Subject: [PATCH] docs, cli: Mention feedback, also via e-mail --- README.md | 16 ++++++++++++++++ radicle-cli/src/commands/help.rs | 5 +++++ 2 files changed, 21 insertions(+) diff --git a/README.md b/README.md index a6c939db..e62ca805 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,16 @@ They can be used as a starting point for further customization. For running in debug mode, see [HACKING.md](HACKING.md). +## Feedback + +If you have feedback, feel free to create issues using `rad issue`, join +[our Zulip][zulip], or email [feedback@radicle.xyz][mail-feedback]. +Emails sent to this address are [automatically posted][zulip-help-email] to +[our **public** #feedback channel on Zulip][zulip-feedback], revealing the +[`From` header][rfc2822s3.6.2] (which usually contains your name and email +address). This allows us to discuss your feedback on Zulip, and, if necessary, +respond to you via email. + ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) and [HACKING.md](HACKING.md) for an @@ -66,3 +76,9 @@ introduction to contributing to Radicle. Radicle is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details. + +[zulip]: https://radicle.zulipchat.com/ +[zulip-feedback]: https://radicle.zulipchat.com/#narrow/channel/392584-feedback +[zulip-help-email]: https://talently.zulip.com/help/message-a-channel-by-email +[mail-feedback]: mailto:feedback@radicle.xyz +[rfc2822s3.6.2]: https://datatracker.ietf.org/doc/html/rfc2822#section-3.6.2 diff --git a/radicle-cli/src/commands/help.rs b/radicle-cli/src/commands/help.rs index 93f3d3be..737552f5 100644 --- a/radicle-cli/src/commands/help.rs +++ b/radicle-cli/src/commands/help.rs @@ -90,5 +90,10 @@ pub fn run(_options: Options, ctx: impl term::Context) -> anyhow::Result<()> { term::print("See `rad --help` to learn about a specific command."); term::blank(); + term::print("Do you have feedback?"); + term::print(" - Chat <\x1b]8;;https://radicle.zulipchat.com\x1b\\radicle.zulipchat.com\x1b]8;;\x1b\\>"); + term::print(" - Mail <\x1b]8;;mailto:feedback@radicle.xyz\x1b\\feedback@radicle.xyz\x1b]8;;\x1b\\>"); + term::print(" (Messages are automatically posted to the public #feedback channel on Zulip.)"); + Ok(()) }