2.8 KiB
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, please read the README.md. 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 or file a Bugzilla bug. If you would rather use email, messages may be sent to the sudo-workers@sudo.ws mailing list (public) or to sudo@sudo.ws (private).
For information on reporting security issues, please see SECURITY.md.
Please include the version of sudo you are using, the operating system and/or distro that is affected, and 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, make your changes, and submit a Pull Request (PR).
-
send a diff with your changes to the sudo-workers@sudo.ws mailing list to start a discussion.
In addition to the GitHub repo, there is also a mercurial repo.
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. Otherwise, discussion can simply occur as part of the PR work flow.
Fuzzing
Sudo uses the oss-fuzz project to perform fuzzing. Each commit to the main branch will trigger a short fuzzing run via the CIFuzz action. 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 is available.
For more information, see https://www.sudo.ws/security/fuzzing/.
Translations
The Free Translation Project provides translations for Sudo. If you would like to contribute to Sudo's translations, please see the ABOUT-NLS file in the Sudo source tree or visit the Free Translation Project's homepage.
There are currently two translation domains: one for the sudo front-end and a separate one for the sudoers module and related utilities.