Hozzájárulás a szemantikai kernelhez

A Szemantikus Kernelhez a problémák elküldésével, a megbeszélések megkezdésével és a lekéréses kérelmek (PRs) beküldésével járulhat hozzá. A kód hozzájárulását nagyra értékeljük, de egyszerűen a felmerülő problémák bejelentése is nagyszerű módja annak, hogy hozzájáruljunk, mivel segít az erőfeszítéseink összpontosításában.

Hibák jelentése és visszajelzés

Mindig üdvözöljük a hibajelentéseket, az API-javaslatokat és az általános visszajelzéseket. Mivel a GitHubot használjuk, a Problémák és vitafórumok fülek segítségével beszélgetést kezdeményezhet a csapattal. Az alábbiakban néhány tippet talál a problémák és visszajelzések elküldéséhez, hogy a lehető leggyorsabban válaszolhassunk a visszajelzésére.

Jelentéskészítési problémák

Az SDK-val kapcsolatos új problémák a problémák listájában jelenthetők meg, de mielőtt új problémát jelentene, keressen rá a problémák listájára, és győződjön meg arról, hogy még nem létezik. Ha problémái vannak a Szemantic Kernel dokumentációjával (ezen a webhelyen), küldjön egy hibát a Szemantic Kernel dokumentációs adattárában.

Ha talál egy meglévő problémát a jelentéskészítéshez, kérjük, adja meg saját visszajelzését a vitában. Azt is erősen javasoljuk, up-voting (👍 reakció) az eredeti post, mivel ez segít nekünk rangsorolni népszerű problémák a mi hátralék.

Jó hibajelentés írása

A jó hibajelentések megkönnyítik a karbantartók számára az alapul szolgáló probléma ellenőrzését és kiváltó okát. Minél jobb egy hibajelentés, annál gyorsabban megoldható a probléma. Ideális esetben a hibajelentésnek a következő információkat kell tartalmaznia:

• A probléma magas szintű leírása.
• Minimális reprodukció, azaz a kód/konfiguráció legkisebb mérete, amely a helytelen viselkedés reprodukálásához szükséges.
• A várt viselkedés leírása, ellentétben a megfigyelt tényleges viselkedéssel.
• A környezettel kapcsolatos információk: operációs rendszer/disztribúció, CPU-architektúra, SDK-verzió stb.
• További információk, például a korábbi verziók regressziója? Vannak ismert megkerülő megoldások?

Létrehozási probléma

Visszajelzés küldése

Ha általános visszajelzése van a Szemantic Kernelről, vagy ötleteket talál a jobbá tétele érdekében, kérjük, ossza meg a vitafórumon. Új vitafórum indítása előtt keressen rá a vitafórumok listájára, és győződjön meg arról, hogy még nem létezik.

Javasoljuk, hogy használja az ötletek kategóriát , ha van egy konkrét ötlete, amelyet meg szeretne osztani, és a Q&A kategóriát , ha kérdése van a szemantikus kernellel kapcsolatban.

A Szemantikus Kernel Discord-kiszolgálóhoz való csatlakozással megbeszéléseket is kezdeményezhet (és megoszthatja a létrehozott visszajelzéseket) a Discord-közösségben.

Vitafórum indítása

Segítség a visszajelzések rangsorolásában

Jelenleg a szavazatok alapján rangsoroljuk a teendőlista problémáit és funkcióit, ezért kérjük, szavazzon az esetleges problémákra vagy vitafórumra, amelyet meg szeretne jeleníteni.

Ha úgy gondolja, hogy mások is profitálnának egy funkcióból, arra is javasoljuk, hogy kérje meg másokat, hogy szavazzanak a problémára. Ez segít rangsorolni azokat a problémákat, amelyek a legtöbb felhasználót érintik. Megkérheti a Discord munkatársait, barátait vagy közösségét, hogy szavazzanak egy problémára a problémára mutató hivatkozás vagy vitafórum megosztásával.

Lekéréses kérelmek elküldése

Örömmel fogadjuk a Szemantic Kernelhez való hozzájárulásokat. Ha hibajavítással vagy új funkcióval rendelkezik, amelyhez hozzá szeretne járulni, kövesse az alábbi lépéseket egy lekéréses kérelem (PR) elküldéséhez. Ezt követően a projektfenntartók áttekintik a kódmódosításokat, és egyesíteni fogják őket, miután elfogadták őket.

Ajánlott közreműködői munkafolyamat

Javasoljuk, hogy az alábbi munkafolyamattal járuljon hozzá a Szemantikus Kernelhez (ez ugyanaz a munkafolyamat, amelyet a Szemantic Kernel csapata használ):

1. Hozzon létre egy problémát a munkájához.
   • Ezt a lépést kihagyhatja a triviális módosítások esetében.
   • Ha van ilyen, használja újra a témakör egyik meglévő problémáját.
   • Kérje meg a csapattól és a közösségtől, hogy a javasolt módosítás jó megoldás a probléma megvitatásával.
   • Egyértelműen adja meg azt a problémát, amelyet a megvalósítás során fog elvégezni. Ez lehetővé teszi, hogy önhöz rendeljük a problémát, és biztosíthassuk, hogy valaki más véletlenül ne működjön rajta.
2. Hozzon létre egy személyes tárházat a GitHubon (ha még nincs ilyen).
3. Az elágazóban hozzon létre egy ágat a főből (git checkout -b mybranch).
   • Nevezze el az ágat, hogy egyértelműen közölje a szándékait, például a "issue-123" vagy a "githubhandle-issue".
4. Végezze el és véglegesítse a módosításokat az ágon.
5. Szükség esetén adjon hozzá a módosításnak megfelelő új teszteket.
6. Hozza létre az adattárat a módosításokkal.
   • Győződjön meg arról, hogy a buildek tisztaak.
   • Győződjön meg arról, hogy a tesztek mind átmennek, beleértve az új teszteket is.
7. Hozzon létre egy pr-t az adattár fő ágához.
   • Adja meg a leírásban, hogy a módosítás milyen problémát vagy fejlesztést jelent.
   • Ellenőrizze, hogy az összes folyamatos integrációs ellenőrzés sikeres-e.
8. Várjon visszajelzést vagy jóváhagyást a módosításokról a kód karbantartóitól.
9. Ha a területtulajdonosok kijelentkeztek, és minden ellenőrzés zöld, a lekéréses kérelem egyesül.

Dos and Dons and Dons while contributing

Az alábbiakban felsoroljuk a Dos és a Don'ts elemet, amelyeket a Szemantic Kernelhez való hozzájáruláskor ajánlunk, hogy a lehető leggyorsabban áttekintsük és egyesíthessük a módosításokat.

Do's:

• Kövesse a standard .NET kódolási stílust és a Python-kódstílust
• Ne adjon elsőbbséget a módosított projekt vagy fájl aktuális stílusának, ha az eltér az általános irányelvektől.
• Új funkciók hozzáadásakor adjon hozzá teszteket. A hibák javításakor először adjon hozzá egy tesztet, amely kiemeli az aktuális viselkedés hibáit.
• Ne tartsa a vitafórumok középpontjában. Amikor új vagy kapcsolódó témakör jön létre, gyakran jobb új problémát létrehozni, mint a vita nyomon követését.
• Egyértelműen állítson be egy olyan problémát, amelyet a megvalósítás során el fog végezni.
• Blogot és/vagy tweetet a hozzájárulásokról!

Mit:

• Ne lepje meg a csapatot nagy lekéréses kérésekkel. Támogatni szeretnénk a közreműködőket, ezért javasoljuk, hogy nyújtsunk be egy problémát, és kezdhessünk el egy megbeszélést, hogy megállapodhassunk egy irányban, mielőtt nagy mennyiségű időt fektetne be.
• Ne véglegesítse a nem írt kódot. Ha olyan kódot talál, amelyet jónak tart a Szemantikus Kernelhez való hozzáadáshoz, küldjön egy problémát, és kezdjen el egy megbeszélést a folytatás előtt.
• Ne küldjön be olyan PRs-eket, amelyek módosítják a licenccel kapcsolatos fájlokat vagy fejléceket. Ha úgy véli, hogy probléma van velük, küldjön egy problémát, és örömmel megvitatjuk.
• Ne hozzon létre új API-kat a probléma bejelentése és a csapattal való első egyeztetés nélkül. Nagy dolog új nyilvános felület hozzáadása egy könyvtárhoz, és szeretnénk, ha minden rendben lenne.

Kompatibilitástörő változások

A hozzájárulásoknak meg kell tartaniuk az API-aláírást és a viselkedési kompatibilitást. Ha olyan módosítást szeretne végezni, amely megszakítja a meglévő kódot, küldjön egy problémát az ötlet vagy a módosítás megvitatásához, ha úgy véli, hogy a kompatibilitástörő módosítás indokolt. Ellenkező esetben a rendszer elutasítja a kompatibilitástörő módosításokat tartalmazó hozzájárulásokat.

A folyamatos integrációs (CI) folyamat

A folyamatos integrációs (CI) rendszer automatikusan elvégzi a szükséges buildeket, és teszteket futtat (beleértve azokat is, amelyeket helyileg is futtatnia kell) a PRS-ekhez. A buildeknek és a tesztelési futtatásoknak tisztanak kell lenniük, mielőtt a lekéréses kérelem összevonható lenne.

Ha a CI-build bármilyen okból meghiúsul, a pr-problémát egy hivatkozással frissítjük, amely a hiba okának meghatározására szolgál, hogy meg lehessen oldani.

Közreműködés a dokumentációban

A Szemantic Kernel dokumentációs adattárához való hozzájárulást is elfogadjuk.