queryverse / queryverse/QuerySQLite.jl

Improve documentation

Offen
#15 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Julia
Sterne
4
Forks
2
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
1

Beschreibung

@davidanthoff I think it probably makes more sense to spend time improving the documentation rather than writing a blog post. One thing I know about myself is that I'm a terrible communicator, so let me know what you think of the documentation as it is and what I should add. Barring that, I'd say this package is ready to announce to the public.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

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

Beginne mit der Durchsicht der aktuellen Dokumentation des Pakets und vergleiche sie mit den Anforderungen einer öffentlichen Ankündigung. Das Issue nennt keine Dokumentationsdateien, Tests oder spezifischen fehlenden Inhalte. Kläre daher die Ergänzungen mit den Maintainer:innen, bevor du beginnst; als erledigt gilt die Aufgabe, wenn die vereinbarten Verbesserungen an der Dokumentation vollständig umgesetzt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
julia
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

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