open-mmlab/mmdetection

[Docs] Request to supply some comment or documentation

Offen

#9.581 geöffnet am 06.01.2023

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (9.820 Forks)batch import
Docgood first issue

Repository-Metriken

Stars
 (32.889 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Branch

master branch https://mmdetection.readthedocs.io/en/latest/

📚 The doc issue

I found no comment or documentations about config files, which is inconvient. For example, what's the main difference between files in configs/common?

Suggest a potential alternative/fix

A short summary in this directory as readme.md is fine. If the information is maintained at other places, it will be appreciated to indicate where it is.

Contributor Guide

Research-Richtung
Untersuche die Konfigurationsdateien im Verzeichnis configs/common, um die wichtigsten Unterschiede zu identifizieren, und schreibe dann eine README.md, die diese Unterschiede zusammenfasst.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90