From 50fde5d815ff28c98359389fcf701ca0a39ddfc4 Mon Sep 17 00:00:00 2001 From: "Todd C. Miller" Date: Thu, 27 Jul 2023 09:51:57 -0600 Subject: [PATCH] Make the sections on bug reporting consistent with each other. GitHub issue #292 --- README.md | 34 +++++++++++++++++++--------------- docs/CONTRIBUTING.md | 24 ++++++++++++++---------- 2 files changed, 33 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 04a7fb4bb..2eabc0588 100644 --- a/README.md +++ b/README.md @@ -79,23 +79,27 @@ fairly low traffic lists so the digest versions are not a significant win. Mailing list archives are also available. See the mailing list web sites for the appropriate links. -## Web page +## Sudo web page -There is a sudo web page at https://www.sudo.ws/ that contains an overview -of sudo, documentation, downloads, a bug tracker, the sudo blog, information -about beta versions and other useful info. +There is a sudo web page at https://www.sudo.ws/ that contains +documentation, downloads, a bug tracker, the source repo, the sudo +blog, information about beta versions and other useful info. -## Bug reports +## Filing bug reports/issues -If you have found what you believe to be a bug, you can file a bug -report in the sudo bug database, at https://bugzilla.sudo.ws/. -Alternately, you can file a GitHub issue if that is easier for you -at https://github.com/sudo-project/sudo/issues/. +If you believe you have found a bug, you can either file a bug +report in the sudo bug database, https://bugzilla.sudo.ws/, or open +a [GitHub issue](https://github.com/sudo-project/sudo/issues), +whichever you find easier. If you would prefer to use email, +messages may be sent to the [sudo-workers@sudo.ws mailing +list](https://www.sudo.ws/mailman/listinfo/sudo-workers) (public) +or to sudo@sudo.ws (private). -See [docs/SECURITY.md](docs/SECURITY.md) for our security policy -and how to report security issues. +For sudo's security policy and how to report security issues, see +[docs/SECURITY.md](docs/SECURITY.md). -Check [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) *before* -submitting a bug report. When reporting bugs, be sure to include -the version of sudo you are using as well as the platform you are -running it on. +Please check [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) +*before* submitting a bug report. When reporting bugs, be sure to +include the version of sudo you are using, the operating system +and/or distro that is affected, and, if possible, step-by-step +instructions to reproduce the problem. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d1d1c1197..415ca4165 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -12,18 +12,22 @@ writing a single line of code. ## Filing bug reports/issues -If you find a bug in Sudo, you may open a [GitHub -issue](https://github.com/sudo-project/sudo/issues) or file a -[Bugzilla bug](https://bugzilla.sudo.ws). If you would rather use -email, messages may be sent to the [sudo-workers@sudo.ws -mailing list](https://www.sudo.ws/mailman/listinfo/sudo-workers) -(public) or to sudo@sudo.ws (private). +If you believe you have found a bug, you can either file a bug +report in the sudo bug database, https://bugzilla.sudo.ws/, or open +a [GitHub issue](https://github.com/sudo-project/sudo/issues), +whichever you find easier. If you would prefer to use email, +messages may be sent to the [sudo-workers@sudo.ws mailing +list](https://www.sudo.ws/mailman/listinfo/sudo-workers) (public) +or to sudo@sudo.ws (private). -For information on reporting security issues, see [SECURITY.md](SECURITY.md). +For sudo's security policy and how to report security issues, see +[SECURITY.md](SECURITY.md). -Include the version of sudo you are using, the operating system -and/or distro that is affected, and, if possible, step-by-step -instructions to reproduce the problem. +Please check [TROUBLESHOOTING.md](TROUBLESHOOTING.md) *before* +submitting a bug report. When reporting bugs, be sure to include +the version of sudo you are using, the operating system and/or +distro that is affected, and, if possible, step-by-step instructions +to reproduce the problem. ## Making changes to Sudo