Напишите белешке о издању на основу захтева за спајање, без интерних детаља
Нека Beeuni прочита повезани GitHub репозиторијум, провери опсег издања и припреми белешке за кориснике са референцама на измене.
Наслов захтева за спајање „Рефакторисање задатка за извоз“ говори рецензенту где да погледа. Кориснику, међутим, не говори много. Белешке о издању треба да објасне шта се у производу променило, на кога то утиче и да ли је измена доступна у том издању.
Утврдите шта је заиста укључено у издање
Омогућите агенту приступ репозиторијуму преко конфигурисане GitHub везе. Затражите да пронађе претходну и тренутну ознаку издања, упореди комите и прегледа повезане захтеве за спајање. Ако се припрема више издања, наведите тачан репозиторијум и ознаке.
Read the connected repository and compare v1.4.0 with v1.5.0.
Draft release notes for users, grouped into features and fixes.
Inspect the linked PRs and diffs rather than relying on titles alone.
Keep a separate list of internal changes, reversions, and uncertain availability.
Save the draft with PR references. Do not publish a release.Спојени PR не мора већ бити пуштен у рад, а измена спојена исте недеље може припадати каснијем издању. Поређење ознака показује који је код укључен. Тим и даље можда треба да потврди стање заставица функција и пуштања у рад.
Нека агент најпре направи интерни радни списак: изворни PR, измењено понашање, корисници на које утиче и да ли је измена укључена у издање. Проверите повучене измене и функције које су и даље искључене. Не укључујте непотврђене ставке у јавни нацрт док их неко не провери.
Од детаља имплементације до белешки за кориснике
Следећи примери показују како се белешке из PR-ова могу уредити за објављивање:
| Радна белешка | Нацрт белешки о издању | Уредничка одлука |
|---|---|---|
| Сачувати изабране филтере у параметрима упита | Дељене везе сада чувају филтере приказа. | Опишите понашање које корисник види |
| Исправити дупло слање при двоструком клику | Исправљена је грешка због које је двоструки клик на „Пошаљи“ могао да направи дупле захтеве. | Наведите радњу и њену последицу |
| Реорганизовати помоћне функције за тестирање | Изоставити из јавних белешки | Задржите радове на одржавању у интерном списку |
| Додати извоз иза искључене заставице функције | Сачекати да извоз постане доступан | Проверите доступност пре објаве |
Групишите измене према ономе што читаоци треба да знају
Када има смисла, користите одељке као што су „Нове функције“, „Побољшања“ и „Исправке“. Изоставите празне наслове. Више PR-ова који заједно остварују једну функцију спојите у једну ставку. Исправке које утичу на различите радње наведите одвојено.
Немојте скривати обавезне кораке у општем списку побољшања. Ако се API поље мења, наведите стари и нови облик и повежите упутства за миграцију. Ако се понашање мења само за одређене налоге или клијенте, наведите на кога се односи. Нека особа одговорна за функцију потврди те детаље.
Сачувајте везу нацрта са изворима
- Задржите референце на PR-ове или комите у верзији за преглед, чак и ако их јавне белешке неће садржати.
- Потврдите да је свака најављена функција доступна у описаном издању.
- Уклоните интерна имена хостова, акредитиве, податке о корисницима и садржај необјављених проблема.
- Замените тврдње као што је „брже“ конкретним описом понашања, осим ако имате мерне податке које можете да цитирате.
Затражите две датотеке: јавни нацрт и радни списак укључених, изостављених и непотврђених ставки. После прегледа можете да затражите од агента да ажурира нацрт у репозиторијуму, ако веза дозвољава упис. Објављивање издања захтева засебно упутство. Ако белешке наводе да је грешка у обрасцу исправљена, водич за тестирање веб-сајта описује запис о репродукцији којим то можете да проверите.
Још чланака
Инфраструктура за RSI истраживање: покретање и евалуација агената који се самопобољшавају
Како Beeuni помаже у вишекратним експериментима побољшавања агената: измене кода и упутстава, тестови, истраживање грешака и поређење верзија.
Користите Beeuni за покретање и евалуацију експеримента финог подешавања модела
Препустите агенту да припреми податке за тренирање, покрене фино подешавање на вашем повезаном рачунару за тренирање, испита грешке и упореди излазе модела.