Probleme

Remedierea unei probleme existente

Una dintre cele mai bune metode de a îmbunătăți documentația este de a remedia o problemă existentă.

1. Răsfoiește lista de probleme.

2. Selectează o problemă la care dorești să lucrezi.

   Important!

   Make sure to [choose an issue][] that matches your level of experience and understanding of OpenTelemetry. Avoid overreaching your capabilities.

3. Citește comentariile la problemă, dacă există.

4. Întreabă administratorii dacă această problemă este încă relevantă și adresează orice întrebări de care ai nevoie pentru clarificări, postând comentarii la problemă.

5. Împărtășește intenția de a lucra la problemă adăugând un comentariu în acest sens.

6. Lucrează la remedierea problemei. Anunță administratorii dacă întâmpini probleme.

7. Când ești gata, trimite lucrarea printr-un pull request (PR).

Raportarea unei probleme

Dacă observi o eroare sau dorești să sugerezi îmbunătățiri la conținutul existent, deschide o problemă.

1. Dă clic pe linkul Creează o problemă de documentație din orice document. Aceasta te redirecționează către o pagină de probleme GitHub prepopulată cu câteva anteturi.
2. Descrie problema sau sugestia de îmbunătățire. Furnizează cât mai multe detalii posibil.
3. Dă clic pe Creează.

După trimitere, verifică problema ocazional sau activează notificările GitHub. Ar putea dura câteva zile până când cei care gestionează problema și cei care aprobă problema vor răspunde. Recenzorii și alți membri ai comunității ar putea pune întrebări înainte de a putea lua măsuri cu privire la problema ta.

Sugerarea de conținut sau funcții noi

Dacă ai o idee pentru conținut nou sau o funcție nouă, dar nu ești sigur unde ar trebui să fie plasată, poți totuși să raportezi o problemă. De asemenea, poți raporta erori și vulnerabilități de securitate.

1. Du-te la GitHub și selectează Noua problemă în interiorul filei Probleme.

2. Selectează tipul de problemă care se aplică cel mai bine solicitării sau nelămuririi tale.

3. Completează tiparul.

4. Trimite problema.

Cum să raportezi probleme excelente

Reține următoarele aspecte atunci când trimiți o problemă:

• Furnizează o descriere clară a problemei. Descrie ce anume lipsește, este învechit, este greșit sau necesită îmbunătățiri.
• Explică impactul specific pe care problema îl are asupra utilizatorilor.
• Limitează domeniul de aplicare al unei anumite probleme la o unitate de lucru rezonabilă. Pentru problemele cu un domeniu de aplicare mare, împarte-le în probleme mai mici. De exemplu, „Remediează documentația de securitate” este prea general, dar „Adaugă detalii la subiectul «Restricționare acces la rețea»” este suficient de specific pentru a fi acționabil.
• Caută problemele existente pentru a vedea dacă există ceva legat sau similar cu noua problemă.
• Dacă noua problemă se referă la o altă problemă sau solicitare de extragere, fă referire la aceasta fie prin adresa URL completă, fie prin numărul problemei sau al solicitării de extragere prefixat cu caracterul „#”. De exemplu, „Introdus de #987654”.
• Urmează Codul de conduită. Respectă-ți colegii contribuitori. De exemplu, „Doctorii sunt groaznici” nu este un feedback util sau politicos.