Architecture Decision Record

Active theme: Light

← dogfennau

Confensiynau enwi ffeiliau

Os byddwch yn dewis creu eich ADRau gan ddefnyddio ffeiliau testun cyffredin, efallai y byddwch am lunio eich confensiwn enwi ffeiliau ADR eich hun.

Rydym ni'n ffafrio confensiwn enwi ffeiliau sydd â fformat penodol.

Enghreifftiau:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Ein confensiwn enwi ffeiliau:

  • Mae'r enw yn cynnwys ymadrodd berfol gorchmynnol yn yr amser presennol. Mae hyn yn helpu darllenadwyedd ac yn cyd-fynd â fformat ein negeseuon ymrwymo.

  • Mae'r enw yn defnyddio llythrennau bach a chysylltnodau (yr un fath â'r ystorfa hon). Mae hyn yn gydbwysedd rhwng darllenadwyedd a defnyddioldeb y system.

  • Markdown yw'r estyniad. Gall hyn fod yn ddefnyddiol er mwyn fformatio'n hawdd.