ordinaryindustries/ReviewKit

Update contribution documentation

Offen

#3 geöffnet am 01.10.2024

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Swift (12 Forks)auto 404
Hacktoberfestdocumentationfeaturegood first issuep3

Repository-Metriken

Stars
 (37 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Update CONTRIBUTING.md to guide users on how to contribute to the framework. Detail at least the following:

  • How to setup a local development environment
  • Code guidelines such as listing
  • How to run testing
  • Github best practices including pull request guidelines
  • How to report issues
  • Code of conduct
  • How the user can get help including the Discord server

Add any additional items you feel would enhance the project's contribution.

Contributor Guide

Research-Richtung
Lesen Sie die aktuelle CONTRIBUTING.md und stellen Sie sicher, dass alle angeforderten Abschnitte (Einrichtung, Codierungsrichtlinien, Tests, Pull Requests, Problemberichte, Verhaltenskodex, Hilfe erhalten) enthalten sind. Fügen Sie zusätzliche Verbesserungen hinzu, um die Beitragserfahrung zu verbessern.
Tech Stack
swift
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85