Wiki source code of intermediate-devops-perspectives-peerreview
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{html wiki="true"}} | ||
| 2 | <div class="ez-academy"> | ||
| 3 | <div class="ez-academy_body"> | ||
| 4 | |||
| 5 | <div class="doc"> | ||
| 6 | |||
| 7 | |||
| 8 | |||
| 9 | = Running peer reviews inside eMagiz DevOps team = | ||
| 10 | |||
| 11 | In this microlearning, we will take a look at peer reviews for eMagiz. | ||
| 12 | |||
| 13 | Should you have any questions, please contact academy@emagiz.com. | ||
| 14 | |||
| 15 | * Last update: April 22nd, 2021 | ||
| 16 | * Required reading time: 8 minutes | ||
| 17 | |||
| 18 | == 1. Prerequisites == | ||
| 19 | |||
| 20 | * Basic knowledge of the eMagiz platform | ||
| 21 | |||
| 22 | == 2. Key concepts == | ||
| 23 | |||
| 24 | Peer reviews are defined as follows: A disciplined engineering practice for detecting and correcting defects in software artifacts and preventing their leakage into production. Its a well known and working concept with IT organization, and it can definetely applied in DevOps teams that have eMagiz as one of the technology pillars. In tbe context of eMagiz, peer reviews are done usually after the Create phase. | ||
| 25 | |||
| 26 | <p align="center">[[image:intermediate-devops-perspectives-peerreview-1.png||]]</p> | ||
| 27 | |||
| 28 | Key benefits of peer reviews | ||
| 29 | |||
| 30 | * Improved quality of integrations | ||
| 31 | * Higher consistency | ||
| 32 | * Knowledge sharing | ||
| 33 | * Keeping standards for optimal maintenance | ||
| 34 | * Architecture challenge and verification | ||
| 35 | * Find alternative solutions | ||
| 36 | |||
| 37 | |||
| 38 | |||
| 39 | == 3. Running peer reviews in eMagiz == | ||
| 40 | |||
| 41 | === 3.1 Considerations for reviewee === | ||
| 42 | |||
| 43 | Here are some things to keep in mind when presenting the work to peer review. | ||
| 44 | |||
| 45 | * Quickly explain the story / task / background | ||
| 46 | * Quickly show the working result if applicable / practical | ||
| 47 | * Talk through the solution while showing the models / code | ||
| 48 | * Just trying to explain your work to someone else will help spot mistakes | ||
| 49 | * Don’t show every single detail but try to highlight the important parts and/or details you’re less sure about. This takes time and experience to get “right” and is different depending on the story, the reviewee, the reviewer, the project, etc. | ||
| 50 | * Always do a peer review, no exceptions. Making assumptions about the usefulness beforehand defeats the whole purpose. | ||
| 51 | |||
| 52 | === 3.2 Considerations for reviewer === | ||
| 53 | |||
| 54 | Here are some things to keep in mind when peer reviewing the work . | ||
| 55 | |||
| 56 | * Ask questions | ||
| 57 | * How does this work? | ||
| 58 | * Why did you decide to …? | ||
| 59 | * Did you think about …? | ||
| 60 | * Spot (incorrect) assumptions | ||
| 61 | * Check application of best practices – see next slide | ||
| 62 | * Modelling / coding patterns | ||
| 63 | * Naming conventions | ||
| 64 | * Errors / warnings | ||
| 65 | * Notice non-standard / unusual / abnormal things | ||
| 66 | * Make sure this is documented, mainly for future changes. Annotations are very useful here. | ||
| 67 | |||
| 68 | === 3.3 Peer review items per ILM Phase === | ||
| 69 | |||
| 70 | * Capture | ||
| 71 | * 100% filled | ||
| 72 | * Connection method clear | ||
| 73 | * Authentication method clear | ||
| 74 | * Definitions loaded | ||
| 75 | * Sizing impact understood and valid | ||
| 76 | * Design | ||
| 77 | * Check solution architecture validity | ||
| 78 | * Design 100% filled and clear | ||
| 79 | * CDM Root entity mapped | ||
| 80 | * Set as mapped – avoid line mapping | ||
| 81 | * Use annotation where possible | ||
| 82 | * Proper flow and system settings | ||
| 83 | * Create | ||
| 84 | * Validate routing | ||
| 85 | * Generic error response flows | ||
| 86 | * Check naming conventions flows, properties and XSD | ||
| 87 | * Split messages in on-ramp – not later | ||
| 88 | * Deploy | ||
| 89 | * Check properties | ||
| 90 | * Avoid too many different flow versions – max. 2 | ||
| 91 | * Remove test packages that are deployed | ||
| 92 | * Manage | ||
| 93 | * All alerts mapped to Customer Support | ||
| 94 | * All messages can be explained | ||
| 95 | * Avoid code mappings | ||
| 96 | * Enable default alerts | ||
| 97 | * Architecture | ||
| 98 | * Deploy connector close to the source/target system | ||
| 99 | * Ensure ACCP and PROD are exact copies | ||
| 100 | * Cloud over on-premise | ||
| 101 | * No hard-coded variable – use properties | ||
| 102 | |||
| 103 | ===== Practice ===== | ||
| 104 | |||
| 105 | == 4. Assignment == | ||
| 106 | |||
| 107 | See how peer reviews are currently implemented within the projects on which you work to see if you can learn something from the information you have gathered via this microlearning. | ||
| 108 | |||
| 109 | == 5. Key takeaways == | ||
| 110 | |||
| 111 | Peer reviews are instrumental in any DevOps team. Use the provided list as your team's peer review starting point and tune as you go along. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | == 6. Suggested Additional Readings == | ||
| 116 | |||
| 117 | You will find plenty background items available on the Internet. | ||
| 118 | |||
| 119 | == 7. Silent demonstration video == | ||
| 120 | |||
| 121 | As this is a more theoretical microlearning we have no video for this. | ||
| 122 | |||
| 123 | </div> | ||
| 124 | |||
| 125 | </div> | ||
| 126 | </div> | ||
| 127 | |||
| 128 | {{/html}} |