ordinaryindustries/ReviewKit

Update contribution documentation

Ouverte

#3 ouverte le 1 oct. 2024

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Swift (12 forks)auto 404
Hacktoberfestdocumentationfeaturegood first issuep3

Métriques du dépôt

Stars
 (37 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Lisez le CONTRIBUTING.md actuel et assurez vous que toutes les sections demandées (configuration, directives de code, tests, demandes de tirage, rapports de problèmes, code de conduite, obtenir de l'aide) sont incluses. Ajoutez toute amélioration supplémentaire pour améliorer l'expérience de contribution.
Stack technique
swift
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85