OpenAI ylläpitää Yhteisön kirjastot -sivua, jolla luettelemme API-asiakkaat, joita kehittäjät voivat käyttää OpenAI API:n käyttöön.
Jos olet rakentanut avoimen lähdekoodin kirjaston, jonka haluaisit lisättävän tälle sivulle – kiitos! On hienoa nähdä, kun kehittäjät rakentavat lisää API-työkaluja muille kehittäjille. Haluamme myös varmistaa, että ohjaamme kehittäjiä hyviin ratkaisuihin, jotka auttavat heitä menestymään pitkällä aikavälillä, joten meillä on muutamia kriteerejä, jotka edellytämme täytettävän ennen kuin listaamme kirjastoja verkkosivustollamme.
Varmista, että täytät alla luetellut kriteerit, ja täytä sitten Yhteisön kirjastot -pyyntölomakkeemme.
Tavallinen avoimen lähdekoodin lisenssi
Jotta kirjasto voidaan listata, edellytämme, että yhteisön kirjastot käyttävät sallivaa avoimen lähdekoodin lisenssiä, kuten MIT-lisenssiä. Näin asiakkaamme voivat tarvittaessa haaroida kirjastoja helpommin, jos niiden omistajat lopettavat niiden ylläpidon tai ominaisuuksien lisäämisen.
Lataa API-avaimet ympäristömuuttujien kautta
README-tiedoston koodiesimerkkien on kannustettava käyttämään ympäristömuuttujia OpenAI API -avaimen lataamiseen sen sijaan, että avain kovakoodattaisiin lähdekoodiin.
Oikea ja laadukas koodi, joka kuvastaa API:a tarkasti
Koodin tulee olla helppolukuista ja helposti seurattavaa, ja sen tulee yleensä noudattaa OpenAPI-määritystämme – uusien kirjastojen ei tule sisältää tässä määrityksessä deprecated: true -merkinnällä merkittyjä endpointteja.
Ilmoita, että kyseessä on epävirallinen kirjasto
Ilmoita README-tiedoston alun lähellä, että kyseessä on ”epävirallinen” tai ”yhteisön ylläpitämä” kirjasto.
Sitoudu ylläpitämään kirjastoa
Tämä tarkoittaa ensisijaisesti ongelmien käsittelyä sekä muutospyyntöjen tarkistamista ja yhdistämistä. Voi myös olla hyvä ajatus ottaa käyttöön Github Issue- ja PR-mallit samaan tapaan kuin virallisessa solmukirjastossamme.