From 098ecdc3115ee20b56fd30942843dce4dce5f188 Mon Sep 17 00:00:00 2001 From: Yorik van Havre Date: Mon, 8 Feb 2021 17:29:52 +0100 Subject: [PATCH] More required items in the github pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 52ba9b834d..91940285da 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,9 +1,12 @@ -Thank you for creating a pull request to contribute to FreeCAD! To ease integration, please confirm the following: +Thank you for creating a pull request to contribute to FreeCAD! To ease integration, we ask you to conform to the following items. Pull requests which don't satisfy all the items below might be rejected. If you are in doubt with any of the items below, don't hesitate to ask for help in the [FreeCAD forum](https://forum.freecadweb.org/viewforum.php?f=10)! -- [ ] Branch rebased on latest master `git pull --rebase upstream master` -- [ ] Unit tests confirmed to pass by running `./bin/FreeCAD --run-test 0` -- [ ] Commit message is [well-written](https://chris.beams.io/posts/git-commit/) -- [ ] Commit message includes `issue #` or `fixes #` where `` is the [associated MantisBT](https://freecadweb.org/wiki/tracker#GitHub_and_MantisBT) issue id if one exists +- [ ] Your pull request is confined strictly to a single module. That is, all the files changed by your pull request are either in `App`, `Base`, `Gui` or one of the `Mod` subfolders. If you need to make changes in several locations, make several pull requests and wait for the first one to be merged before submitting the next ones +- [ ] In case your pull request does more than just fixing small bugs, make sure you discussed your ideas with other developers on the FreeCAD forum +- [ ] Your branch is [rebased](https://git-scm.com/docs/git-rebase) on latest master `git pull --rebase upstream master` +- [ ] All FreeCAD unit tests are confirmed to pass by running `./bin/FreeCAD --run-test 0` +- [ ] All commit messages are [well-written](https://chris.beams.io/posts/git-commit/) ex: `Fixes typo in Draft Move command text` +- [ ] Your pull request is well written and has a good description, and its title starts with the module name, ex: `Draft: Fixed typos` +- [ ] Commit messages include `issue #` or `fixes #` where `` is the [FreeCAD bug tracker issue number](https://freecadweb.org/wiki/tracker#GitHub_and_MantisBT) in case a particular commit solves or is related to an existing issue on the tracker. Ex: `Draft: fix typos - fixes #0004805` And please remember to update the Wiki with the features added or changed once this PR is merged. **Note**: If you don't have wiki access, then please mention your contribution on the [0.19 Changelog Forum Thread](https://forum.freecadweb.org/viewtopic.php?f=10&t=34586).