From 03b0a35c0a34b573f796964af710ca7b45ecf5b9 Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Wed, 11 Mar 2026 10:08:47 +0100 Subject: [PATCH] add a hint on running CI before opening a PR --- CONTRIBUTING.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f8577b7..2cbdf678 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,20 +15,24 @@ explained at https://help.github.com/articles/using-pull-requests You should fork the project into your own repo, create a topic branch -there and then make one or more pull requests back to the openstreetmap repository. -Your pull requests will then be reviewed and discussed. Please be aware -that you are responsible for your pull requests. You should be prepared -to get change requests because as the maintainers we have to make sure -that your contribution fits well with the rest of the code. Please make -sure that you have time to react to these comments and amend the code or -engage in a conversation. Do not expect that others will pick up your code, -it will almost never happen. +there and then make a single pull requests back to the main repository. +Your pull requests will then be reviewed and discussed. -Please open a separate pull request for each issue you want to address. -Don't mix multiple changes. In particular, don't mix style cleanups with -feature pull requests. If you plan to make larger changes, please open -an issue first or comment on the appropriate issue already existing so -that duplicate work can be avoided. +Please make sure to follow these guidelines: + +* Make sure CI passes _before_ opening the pull request. The repo is configured + to run the CI on branches. Once you have enabled the CI on your forked + repo, Actions will execute every time you push to your branch. Check + the Actions tab in your repo to make sure everything works. +* Make sure that you have time to react to these comments and amend the code or + engage in a conversation. Do not expect that others will pick up your code, + it will almost never happen. +* Open a separate pull request for each issue you want to address. + Don't mix multiple changes. In particular, don't mix style cleanups with + feature pull requests. +* For small fixes and amendmends open a PR directly. + If you plan to make larger changes, please open an issue first or comment + on the appropriate issue to outline your planned implementation. ### Using AI-assisted code generators