From c8eefab345cc22da06ca309c2234bae3bc24cff9 Mon Sep 17 00:00:00 2001 From: Chris Hennes Date: Sun, 2 Nov 2025 12:52:22 -0600 Subject: [PATCH] Project: Revise PR message guidelines for clarity --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5faffe2bb6..47001d2551 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,7 +57,7 @@ The FreeCAD Contribution Process is expressed here with the following specific g 9. A PR MUST compile cleanly and pass project self-tests on all target platforms. 10. Changes that break python API used by extensions SHALL be avoided. If it is not possible to avoid breaking changes, the amount of them MUST be minimized and PR MUST clearly describe all breaking changes with clear description on how to replace no longer working solution with newer one. Contributor SHOULD search for addons that will be broken and list them in the PR. 11. Each commit message in a PR MUST succinctly explain what the commit achieves. The commit message SHALL follow the suggestions in the `git commit --help` documentation, section DISCUSSION. -12. The PR message MUST consist of a single short line, the PR Title, summarizing the problem being solved, followed by a blank line and then the proposed solution in the Body. If a PR consists of more than one commit, the PR Title MUST succinctly explain what the PR achieves. The Body MAY be as detailed as needed. If a PR changes the user interface (UI), the body of the text MUST include a presentation of these UI changes, preferably with screenshots of the previous and revised state. +12. The PR Title MUST succinctly explain what the PR achieves. The Body MAY be as detailed as needed. If a PR changes the user interface (UI), the body of the text MUST include a presentation of these UI changes, preferably with screenshots of the previous and revised state. 13. If a PR contains the work of another author (for example, if it is cherry-picked from a fork by someone other than the PR-submitter): 1. the PR description MUST contain proper attribution as the first line, for example: "This is work of XYZ cherry-picked from "; 2. all commits MUST have proper authorship, i.e. be authored by the original author and committed by the author of the PR;