python / python/cpython

Improve the "Dealing with Bugs" documentation, include guidelines on how to report bugs

Offen
#81,792 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs type-feature
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
558

Beschreibung

BPO 37611
Nosy @kmoza, @Mariatta

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2019-07-17.17:42:36.597>
labels = ['type-feature', 'docs']
title = 'Improve the "Dealing with Bugs" documentation, include guidelines on how to report bugs'
updated_at = <Date 2019-07-19.15:25:23.693>
user = 'https://github.com/Mariatta'

bugs.python.org fields:

activity = <Date 2019-07-19.15:25:23.693>
actor = 'Mariatta'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-07-17.17:42:36.597>
creator = 'Mariatta'
dependencies = []
files = []
hgrepos = []
issue_num = 37611
keywords = []
message_count = 3.0
messages = ['348077', '348176', '348180']
nosy_count = 3.0
nosy_names = ['docs@python', 'Krishna Oza', 'Mariatta']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue37611'
versions = []

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Finde die vorhandene Dokumentation „Dealing with Bugs“ in den CPython-Dokumenten und lies die aktuellen Hinweise. Füge Richtlinien hinzu, die erklären, wie Benutzer Fehler melden sollen, und überprüfe anschließend, dass der Abschnitt den angeforderten Meldeprozess klar abdeckt und dem Stil der umgebenden Dokumentation folgt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.