From ae581a19fbe896a797450b9d9573fb66f2735227 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 16:37:38 +0200 Subject: Adding upstream version 1.9.13p3. Signed-off-by: Daniel Baumann --- docs/CONTRIBUTING.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 docs/CONTRIBUTING.md (limited to 'docs/CONTRIBUTING.md') diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..d1d1c11 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,84 @@ +Contributing to Sudo +==================== + +Thank you for your interest in contributing to Sudo! There are a +number of way you can help make Sudo better. + +## Getting started + +To get an overview of Sudo, see the [README.md](../README.md) file. +There are multiple ways to contribute, some of which don't require +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). + +For information on reporting 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. + +## Making changes to Sudo + +If you are interested in making changes to Sudo there are two main +work flows: + + * clone the [sudo repo](https://github.com/sudo-project/sudo), make + your changes, and submit a Pull Request (PR). + + * send a diff with your changes to the [sudo-workers@sudo.ws mailing + list](https://www.sudo.ws/mailman/listinfo/sudo-workers) to start + a discussion. + +In addition to the [GitHub repo](https://github.com/sudo-project/sudo), +there is also a [mercurial repo](https://www.sudo.ws/repos/sudo). + +## sudo-workers mailing list + +If you would like to discuss your changes before submitting a +PR, you may do so on the [sudo-workers@sudo.ws mailing +list](https://www.sudo.ws/mailman/listinfo/sudo-workers). +Otherwise, discussion can simply occur as part of the PR work flow. + +## Fuzzing + +Sudo uses the [oss-fuzz project](https://github.com/google/oss-fuzz.git) +to perform fuzzing. Each commit to the _main_ branch will trigger +a short fuzzing run via the [CIFuzz +action](https://github.com/sudo-project/sudo/actions/workflows/main.yml). +The history of that action shows successful and failed fuzzing runs. + +Longer fuzzing runs occur using the ClusterFuzz infrastructure. These +fuzzing runs are longer than those used by CIFuzz. A [public list of +failures](https://bugs.chromium.org/p/oss-fuzz/issues/list?q=sudoers) +is available. + +For more information, see https://www.sudo.ws/security/fuzzing/. + +## Translations + +Sudo uses [GNU gettext](https://www.gnu.org/software/gettext/) for +its National Language Support (NLS). Strings in sudo and related +programs are collected in `.pot` files that can be translated into +multiple languages. + +Translations for sudo are coordinated by the [Translation +Project](https://translationproject.org). If you would like to +contribute to Sudo's translations, please join a translation team +at the Translation Project instead of contributing a `.po` file +directly. This will avoid duplicated work if there is already a +translation in progress. If you would like to become a member of +a translation team, please follow the [instructions for +translators](https://translationproject.org/html/translators.html). + +There are currently two translation domains: [one for the sudo +front-end](https://translationproject.org/domain/sudo.html) and a +[separate one for the sudoers module and related +utilities](https://translationproject.org/domain/sudoers.html). -- cgit v1.2.3