Чи посилання на помилку / проблему у повідомленні про комісію вважається хорошою практикою?

Я працюю над проектом, де у нас встановлено управління джерелом для автоматичного запису приміток у трекер помилок. Ми просто записуємо ідентифікатор проблеми помилки у повідомленні про фіксацію, а повідомлення про фіксацію додається як примітка до трекера помилок.

Я бачу лише кілька недоліків цієї практики. Якщо десь у майбутньому вихідний код відокремлюється від програмного забезпечення для відстеження помилок (або повідомлені помилки / проблеми якимось чином втрачаються). Або коли хтось переглядає історію комітетів, але не має доступу до нашого відстежувача помилок.

Моє запитання, чи вважати посилання на помилку / проблему у повідомленні про комісію доброю практикою? Чи є якісь інші мінуси?

Ми прийняли цю практику, і вона дуже добре працює на нас. Дуже цінна інтеграція між системою управління версіями (VCS) та іншими системами, якими ми користуємось, наприклад, безперервна інтеграція, відслідковування помилок тощо. Якщо ми коли-небудь щось змінимо в майбутньому, нам, безумовно, доведеться оцінити побічні ефекти, включаючи зв’язки між системою VCS та системою відстеження помилок.

Взагалі я б вважав це гарною практикою. Для деяких систем відстеження доступні додаткові параметри та інструменти, наприклад властивості bugtraq для Subversion (SVN). Це говорить про те, що досить багато людей бачать цінність у цій практиці.

Якщо ви хочете зробити справді, дуже впевненим, що інформація не втрачається, навіть якщо ви можете використовувати інший трекер помилок у майбутньому, або дані вашої помилки про помилки якимось чином зникнуть, чому б просто не ввести ідентифікатор проблеми та коротке пояснення про помилку повідомлення про фіксацію?

Виправлена ​​помилка № 123: додаток вийшов з ладу після входу

Тоді у вас ще є посилання з історії комісій до трекера помилок - і якщо трекер помилок коли-небудь буде недоступним, ви все ще можете бачити в історії про що саме ця помилка.

Це дуже поширена практика, і я вважаю це надзвичайно зручним. Я використовую TRAC, тому я можу прочитати історію коду та перейти до завдання, яке призвело до зміни, або прочитати історію завдань та перейти до змін коду.

"Якщо колись у майбутньому ..." Якщо ви відокремили код від програми відстеження помилок, то стара історія версій, ймовірно, не представлятиме додаткового інтересу.

Я також використовую цю практику, і я вважаю її дуже хорошою. Але крім ідентифікатора проблеми я додаю короткий опис помилки / функції (як правило, заголовок із системи відстеження помилок). Це часто допомагає заощадити час, оскільки мені не доведеться шукати в системі відстеження помилок (бо я визнаю зміни) І, як ви сказали, якщо я якось втрачаю систему відстеження помилок, я не буду повністю втрачений.