Повідомлення про баг

Дата оновлення перекладу 2023-08-25

Повідомлення про баг

Щоразу, коли ви знаходите баг в Symfony, ми просимо вас повідомляти про нього. Це допоможе нам зробити Symfony кращою.

Caution

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

Перш ніж надсилати повідомлення про баг:

  • Ретельно перевірте офіційну документацію, щоб переконатися, що ви не використовуєте фреймворк неправильно;
  • Зверніться за допомогою до Stack Overflow, на #каналі підтримки Symfony Slack, якщо ви не впевнені, що ваша проблема дійсно є багом.

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

  • Використовуйте поле заголовка, щоб чітко описати проблему;
  • Опишіть кроки, необхідні для відтворення багу, за допомогою коротких прикладів коду (найкраще надати модульний тест, який ілюструє баг);
  • Якщо баг, з яким ви зіткнулися, не є простим або зачіпає більше одного рівня, надання простого невдалого модульного тесту може бути недостатньо. У цьому випадку будь ласка надайте відтворювач;
  • Надайте якомога більше інформації про ваше середовище (ОС, версія PHP, версія Symfony, увімкнені розширення, ...);
  • Якщо сталося виключення і ви хочете повідомити про нього, то корисно надати трасування стеку для цього виключення. Якщо ви хочете надати трасування стеку, яке ви отримали на HTML-сторінці, переконайтеся, що ви надаєте текстову версію, яка має з'явитися у нижній частині сторінки. Не надавайте його у вигляді скріншоту, оскільки пошукові системи не зможуть проіндексувати текст, що міститься в них. Те ж саме стосується помилок, що виникають в терміналі - не робіть скріншот, а скопіюйте/вставте його зміст. Якщо трасування стеку є довгим, подумайте про те, щоб помістити його у <details> HTML-тег. Будьте обережні, оскільки трасування стеку може містити конфіденційну інформацію, і якщо це так, обов'язково відредагуйте це перед публікацією трасування стеку.
  • (не обов'язково) Прикріпіть файл з патчем.