Architecture Decision Record
← Samfuran rikodin shawara

Samfurin Rikodin Shawarar Gine-gine (ADR)

Wannan samfuri ne na ADR na EdgeX Foundry.

Tushe: https://docs.edgexfoundry.org/2.3/design/adr/template/

Masu gabatarwa

Jera masu gabatar da ADR.

Tsari:

  • Suna (Ƙungiya)

Rajistar Canje-canje

Jera canje-canjen da aka yi a takardar, ciki har da yanayi, kwanan wata, da URL na PR.

Yanayi ɗaya ne daga cikin: jira, an amince, an gyara, an daina amfani.

Kwanan wata zaren ISO 8601 ne (YYYY-MM-DD).

PR shi ne pull request wanda ya gabatar da canjin, ciki har da bayani kamar diff, masu ba da gudummawa, da masu bita.

Tsari:

  • [Yanayin ADR misali an amince, an gyara, da sauransu](URL na pull request) YYYY-MM-DD

Yanayin Amfani da Aka Ambata

Jera duk takardun yanayin amfani / buƙatu masu dacewa.

ADR yana buƙatar aƙalla yanayin amfani ɗaya mai dacewa kuma wanda aka amince da shi.

Tsari:

  • [Sunan Yanayin Amfani](URL)

Ƙara bayani idan ADR ba ya magance duk buƙatun wani yanayin amfani.

Mahalli

Bayyana:

  • yadda ƙirar ke da muhimmanci ta fuskar gine-gine - wanda ke tabbatar da ADR (maimakon issue da PR masu sauƙi don gyara matsala)

  • hanyar ƙira ta matakin sama (cikakken bayani yana cikin ƙirar da aka ba da shawara a ƙasa)

Ƙirar da Aka Ba da Shawara

Cikakken bayanin ƙirar (ba tare da shiga aiwatarwa ba idan zai yiwu).

Jigon bayani:

  • ayyuka/ɓangarorin da abin zai shafa (canzawa)

  • sababbin ayyuka/ɓangarori da za a ƙara

  • tasiri a kan samfura da DTO (canje-canje/ƙari/cirewa)

  • tasiri a kan API (canje-canje/ƙari/cirewa)

  • tasiri a kan saitin gama gari (kafa sababbin sassa, canje-canje/ƙari/cirewa)

  • tasiri a kan devops

La’akari

Rubuta madadin, damuwa, batutuwa masu alaƙa ko na taimako, da tambayoyin da suka taso a muhawarar ADR.

Nuna ko an warware su ko an rage su da yadda.

Shawara

Rubuta duk wani muhimmin bayanin aiwatarwa da aka amince da shi, gargaɗi, la’akari na nan gaba, matsalolin ƙira da suka rage ko aka jinkirta.

Rubuta kowane ɓangaren buƙatu da ƙirar da aka ba da shawara ba ta cika ba.

Sauran ADR Masu Alaƙa

Jera kowane ADR mai dacewa - kamar shawarar ƙira don ƙaramin ɓangare na siffa, ƙirar da aka daina amfani da ita saboda wannan ƙira, da sauransu.

Tsari:

  • [Take na ADR](URL) - Dacewa

Bayanan Tunani

Jera ƙarin bayanan tunani.

Tsari:

  • [Take](URL)