Architecture Decision Record

Active theme: Light

← दस्तऐवज

ADR साठी फाईल नाव परंपरा

तुम्ही तुमचे ADR सामान्य मजकूर फाईलींमध्ये तयार करायचे ठरवल्यास, तुम्हाला ADR फाईलींसाठी स्वतःची नाव परंपरा ठरवायची असेल.

आम्ही विशिष्ट स्वरूप असलेली फाईल नाव परंपरा वापरणे पसंत करतो.

उदाहरणे:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

आमची फाईल नाव परंपरा:

  • नावात वर्तमानकाळातील आज्ञार्थी क्रियापद वाक्यांश असतो. यामुळे वाचनीयता वाढते आणि ते आमच्या कमिट संदेशाच्या स्वरूपाशी जुळते.

  • नावात लहान अक्षरे आणि डॅश वापरले जातात (या रिपॉझिटरीप्रमाणे). हा वाचनीयता आणि प्रणालीच्या उपयोगितेतील समतोल आहे.

  • विस्तार markdown आहे. सुलभ स्वरूपणासाठी हे उपयुक्त ठरू शकते.