From 8819cb7cbd1ed991f5d4d7fa1ac4af5719b61595 Mon Sep 17 00:00:00 2001 From: Lars Vogdt Date: Dec 09 2019 16:34:11 +0000 Subject: Merge branch 'lrupp-production-patch-51676' into 'production' Add "Rules and workflows" section See merge request infra/salt!287 --- diff --git a/README.md b/README.md index aede821..3997e48 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,27 @@ Debugging salt on your client (the machine running the salt-minion) via: ___/ / /_/ / / /_ ___/ / /_/ /_/ / /__/ ,< /____/\__,_/_/\__//____/\__/\__,_/\___/_/|_| ``` + + +Rules and workflows +------------------- + +The general workflow should be to create a branch (either directly in this repository or in a clone), do your changes, commit and create a merge request for review. This gives other team members the possibility to notice and review your changes. It even sends out Emails, so other team members get aware of changes. + +On the other side, we do not want to block anyone from being productive. So here are the general rules: + +* **Always use merge requests.** +* We allow to merge those requests on your own - but we want to make use of the benefits of merge requests (notifications, tests, visibility). + + +Merge requests that **require a review**: +* changes that might affect a bigger amount of machines - especially, if this affects machines maintained by others +* potentially dangerous stuff that might break existing setups + +Merge requests that **could be self-merged**: +* emergency updates fixing something that is already broken (think about a new Gateway IP as example) +* typo fixes (includes whitespace fixes) +* stuff that is interesting only for machines that the requester maintains +* stuff that nobody was able to review for more than one week + +This README.md file should be reviewed every quarter during a Heroes Meeting.