आर्किटेक्चर फैसला रिकॉर्ड (ADR) टेम्पलेट
ई EdgeX Foundry ADR खातिर एगो टेम्पलेट ह।
स्रोत: https://docs.edgexfoundry.org/2.3/design/adr/template/
प्रस्तुतकर्ता
ADR के प्रस्तुतकर्ता लोग के सूची दीं।
रूप:
- नाम (संगठन)
बदलाव लॉग
दस्तावेज में भइल बदलाव के सूची दीं, जवना में स्थिति, तारीख, आ PR URL शामिल होखे।
स्थिति एह में से एक होला: लंबित, मंजूर, संशोधित, अनुशंसित ना।
तारीख ISO 8601 (YYYY-MM-DD) स्ट्रिंग होला।
PR ऊ पुल रिक्वेस्ट ह जे बदलाव जमा कइलस, जवना में diff, योगदानकर्ता, आ समीक्षक जइसन जानकारी शामिल बा।
रूप:
- [ADR के स्थिति जइसे मंजूर, संशोधित, वगैरह](पुल रिक्वेस्ट के URL) YYYY-MM-DD
संदर्भित उपयोग के मामला
सब प्रासंगिक उपयोग के मामला / जरूरत के दस्तावेज के सूची दीं।
ADR के कम से कम एक प्रासंगिक, मंजूर उपयोग के मामला चाहीं।
रूप:
- [उपयोग के मामला के नाम](URL)
अगर ADR कवनो उपयोग के मामला के सब जरूरत के संबोधित नइखे करत, त स्पष्टीकरण जोड़ीं।
संदर्भ
बतावीं:
डिजाइन आर्किटेक्चर के लिहाज से कइसे महत्त्वपूर्ण बा - जे ADR के सही ठहरावेला (समस्या ठीक करे खातिर सादा issue आ PR के बजाय)
उच्च-स्तर के डिजाइन दृष्टिकोण (ब्योरा नीचे प्रस्तावित डिजाइन में दिहल बा)
प्रस्तावित डिजाइन
डिजाइन के ब्योरा (जहाँ संभव होखे लागू करे में उतरल बिना)।
रूपरेखा:
कवन सर्विस/मॉड्यूल प्रभावित होई (बदली)
कवन नया सर्विस/मॉड्यूल जोड़ल जाई
मॉडल आ DTO पर असर (बदलाव/जोड़ल/हटावल)
API पर असर (बदलाव/जोड़ल/हटावल)
सामान्य कॉन्फिगरेशन पर असर (नया खंड बनावल, बदलाव/जोड़ल/हटावल)
devops पर असर
विचार
ADR के बहस में उठल विकल्प, चिंता, सहायक चाहे संबंधित मुद्दा, आ सवाल दर्ज करीं।
बतावीं कि ऊ सभ हल भइल चाहे नरम भइल कि ना आ कइसे।
फैसला
कवनो सहमत महत्त्वपूर्ण कार्यान्वयन ब्योरा, चेतावनी, आगे के विचार, बाकी चाहे टालल गइल डिजाइन मुद्दा दर्ज करीं।
जरूरत के ऊ कवनो हिस्सा दर्ज करीं जे प्रस्तावित डिजाइन से पूरा ना होला।
आउर संबंधित ADR
कवनो प्रासंगिक ADR के सूची दीं - जइसे कवनो फीचर के उप-घटक खातिर डिजाइन फैसला, एह डिजाइन के चलते अनुशंसित ना कइल गइल डिजाइन, वगैरह।
रूप:
- [ADR के शीर्षक](URL) - प्रासंगिकता
संदर्भ सामग्री
अतिरिक्त संदर्भ सामग्री के सूची दीं।
रूप:
- [शीर्षक](URL)