From 6e87ff5235a3396c89f36c1a02462743630bef99 Mon Sep 17 00:00:00 2001 From: Tobias Hofmann Date: Sun, 25 Feb 2024 13:16:37 +0100 Subject: [PATCH] added md suffix --- PROCESS.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 PROCESS.md diff --git a/PROCESS.md b/PROCESS.md new file mode 100644 index 0000000..4ccd2ac --- /dev/null +++ b/PROCESS.md @@ -0,0 +1,73 @@ +# Publishing process + +This document explains how a new version of the SAP development tech radar (SDTR) is authored and published. + +The graphic provides the general process, including the involved steps, tasks and timeline. + +```mermaid +timeline + title SAP dev tech radar process + section Release new public version + Version N : Version N published + Phase
Collect Proposals : Add new technology : Suggest change : Remove technology + Phase
Quality Check : Quality check of proposals + Phase
Vote : Vote proposals : Add accepted changes + Publish Version
N+1 : Version N + 1 published +``` + +Everyone can add a technology. While the SDTR is independent from SAP, SAP employees can submit changes, and are invited to do so. The indepence from SAP is ensured by the voting process. SAP employees cannot cast a vote. + +## General remarks + +### New published version + +A new published version is planned to occur at least twice a year, with a max of 4. Each quarter not more than one version must be published. + +The version name should reflect this: YEAR.COUNTER. While the year is the 4 digit number of the year, counter should indicate the month number in 2 digits. 2024.01 indicates that the version was published in January 2024. 2024.06 stands for the version published in June 2024. Even with two published version a year, the counter does not indicate the published number in that year. The version number therefore gives clear information on how old the current published SDTR is. + +### Propose changes + +Changes can be proposed only after a new version was published. Therefore, changes are relative to the latest SDTR version. A new cycle for collecting changes is announced via a git issue. + +Each new version starts with a phase where proposals are collected. Changes to the technology are proposed via git. See the CONTRIBUTING documentation on how to propose a change. This happens by providing the needed information to a specific git branch. In case the person submitting cannot do so, the proposal can also be submitted via an issue. + +For adding a new technology, the provided tempate must be used. For changing an existing technology (move ring, change information), the currently used definition serves as template. + +### Quality check + +Submissions are checked for quality. Specific information must be provided for the technology. Only then the change is added to the current backlog. + +### Voting proposed changes + +All proposals that passed the quality check are analyzed and voted for. The voting is to determine if or if not the change is added as-is to the SDTR. The indepence from SAP is ensured by the voting process. SAP employees cannot cast a vote. + +### Publishing + +Pusblishing of accepted changes to the SDTR happens by merging the changes to the main branch. A new version is tagged as a release and published on the web page. After this, the new SDTR is automatically active and the new published version. + +```mermaid +gitGraph TB: + commit id: "Published 2024.01" type: HIGHLIGHT tag: "2024.01" + branch proposals-2024.03 + checkout proposals-2024.03 + commit id: "Workzone" + commit id: "BTP" + branch vote-2024.03 + checkout vote-2024.03 + commit id: "Voting 2024.03 Results" + checkout main + merge vote-2024.03 + commit id: "Published 2024.03" type: HIGHLIGHT tag: "2024.03" + branch proposals-2024.06 + checkout proposals-2024.06 + commit id: "ADT" + commit id: "Fiori UX" + commit id: "SolMan" + branch vote-2024.06 + checkout vote-2024.06 + commit id: "Voting 2024.06 Results" + checkout main + merge vote-2024.06 + commit id: "Published 2024.06" type: HIGHLIGHT tag: "2024.06" +``` +