From 65d5017ee0fb2250e2ad90ce8478e1fb0ba87022 Mon Sep 17 00:00:00 2001 From: leiaru-c <77273152+leiaru-c@users.noreply.github.com> Date: Mon, 2 Feb 2026 13:38:11 +0000 Subject: [PATCH] Enhance contributing guidelines for CUPS Expanded the contributing guidelines to include documentation contributions and review processes. --- CONTRIBUTING.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f20e3090c3..94fcc8f481 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,25 @@ Contributing to CUPS ==================== +CUPS is developed by OpenPrinting and distributed as open source software under the Apache License, Version 2.0 with exceptions to allow linking to GPL2/LGPL2 code. -CUPS is developed by OpenPrinting and distributed as open source software under -the Apache License, Version 2.0 with exceptions to allow linking to GPL2/LGPL2 -code. +Thank you for wanting to help us improve CUPS! There are a variety of ways you can contribute to this project, including no-code and low-code options. This documentation will help orient you with our processes. -Contributions should be submitted either as pull requests or as attachments -(unified diffs) to bug reports on the OpenPrinting CUPS GitHub project at -. +Please make sure that you read this guide before starting to contribute. It contains all the details you need to know to give your contribution the best chance of being accepted. + +Contributions should be submitted either as pull requests or as attachments (unified diffs) to bug reports on the OpenPrinting CUPS GitHub project at [https://github.com/openprinting/cups](https://github.com/openprinting/cups). + +## Documentation contributions + +CUPS is hosted and managed on GitHub. If you're not familiar with how GitHub works, their [quickstart documentation](https://docs.github.com/en/get-started/start-your-journey) provides an excellent introduction to all the tools and processes you will need to know. + +To contribute to the CUPS documentation, you will need to fork the project. Once you have done so, you will need to open a pull request to add or edit the material in the doc folder. + +### Documentation contribution reviews + +We are a small team of volunteers so reviews can take a bit of time. Please be patient, we will do our best to get to your contribution as quickly as possible. + +If we need to reject your contribution, you will receive comments about why and what needs to be changed. If it is accepted, your PR will be merged and reallocated where necessary by the maintaining team. + +We will review contributions based on two main aspects: style and technical accuracy. For style reviews, please follow this [style guide](https://developer.gnome.org/documentation/guidelines/devel-docs.html). + +For technical reviews, the person who wrote the code you are documenting will review your contribution to make sure it is accurate.