ordinaryindustries/ReviewKit

Update contribution documentation

Aperta

#3 aperta il 1 ott 2024

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Swift (12 fork)auto 404
Hacktoberfestdocumentationfeaturegood first issuep3

Metriche repository

Star
 (37 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Leggi l'attuale CONTRIBUTING.md e assicurati che siano incluse tutte le sezioni richieste (configurazione, linee guida del codice, test, richieste pull, segnalazione problemi, codice di condotta, ottenere aiuto). Aggiungi eventuali miglioramenti aggiuntivi per migliorare l'esperienza di contribuzione.
Tech stack
swift
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85