OpenAI
Ang page na ito ay isinalin ng AI. Tingnan ang orihinal na artikulo sa English.

Paano ko maidaragdag ang aking API client sa pahina ng Community Libraries?

Mga pamantayan at hakbang para matiyak na handa ang iyong library na maidagdag sa aming pahina ng Community Libraries

Na-update: 21 days ago

Ang OpenAI ay nagpapanatili ng pahina ng Mga Library ng Komunidad kung saan namin inililista ang mga API client na magagamit ng mga developer para ma-access ang OpenAI API.

Kung nakagawa ka ng open source library na gusto mong maidagdag sa pahinang ito – salamat! Gusto naming makitang gumagawa ang mga developer ng karagdagang API tooling para sa iba pang mga developer. Nais din naming matiyak na ginagabayan namin ang mga developer sa mahuhusay na solusyon na magtatagumpay sa kanila sa pangmatagalan, kaya mayroon kaming ilang pamantayang kinakailangan bago maglista ng mga library sa aming website.

Pakitiyak na natutugunan mo ang mga pamantayang nakalista sa ibaba, at pagkatapos ay punan ang aming form ng kahilingan para sa Mga Library ng Komunidad.

  1. Karaniwang open source na lisensya

Para mailista, hinihiling namin na gumamit ang mga community library ng permissive na open-source na lisensya gaya ng MIT. Nagbibigay-daan ito sa aming mga customer na mas madaling mag-fork ng mga library kung kinakailangan sakaling tumigil ang mga may-ari sa pagpapanatili nito o pagdaragdag ng mga feature.

  1. I-load ang mga API key sa pamamagitan ng environment variables

Dapat hikayatin ng mga code sample sa README ang paggamit ng environment variables para i-load ang OpenAI API key, sa halip na i-hardcode ito sa source code.

  1. Tama at mataas ang kalidad na code na tumpak na sumasalamin sa API

Dapat madaling basahin/sundan ang code, at sa pangkalahatan ay dapat sumunod sa aming OpenAPI spec – ang mga bagong library ay hindi dapat magsama ng mga endpoint na minarkahan bilang deprecated: true sa spec na ito.

  1. Sabihing isa itong hindi opisyal na library

Pakisabi sa bahagi malapit sa itaas ng iyong README na isa itong “hindi opisyal” o “pinapanatili ng komunidad” na library.

  1. Mangakong pananatilihin ang library

Pangunahing nangangahulugan ito ng pagtugon sa mga issue at pag-review+merge ng mga pull request. Maaari ring magandang ideya na mag-set up ng mga template para sa Github Issue at PR tulad ng mayroon kami sa aming opisyal na node library.

Nakatulong ba ang artikulong ito?