قراردادهای نامگذاری فایل برای ADR

اگر تصمیم دارید ADRهای خود را با فایل‌های متنی معمولی ایجاد کنید، ممکن است بخواهید قرارداد نامگذاری فایل ADR مخصوص خودتان را تعیین کنید.

ما ترجیح می‌دهیم از قراردادی برای نامگذاری فایل استفاده کنیم که قالب مشخصی دارد.

نمونه‌ها:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

قرارداد نامگذاری فایل ما:

• نام شامل یک عبارت فعلی امری در زمان حال است. این کار خوانایی را بهبود می‌دهد و با قالب پیام‌های کامیت ما همخوان است.

• نام از حروف کوچک و خط تیره استفاده می‌کند (مانند همین مخزن). این تعادلی میان خوانایی و قابلیت استفاده در سیستم است.

• پسوند markdown است. این می‌تواند برای قالب‌بندی آسان مفید باشد.