ordinaryindustries/ReviewKit

Update contribution documentation

Open

#3 opened on Oct 1, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Swift (12 forks)auto 404
Hacktoberfestdocumentationfeaturegood first issuep3

Repository metrics

Stars
 (37 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Read the current CONTRIBUTING.md and ensure all requested sections (setup, code guidelines, testing, pull requests, issue reporting, code of conduct, getting help) are included. Add any additional enhancements to improve contribution experience.
Tech stack
swift
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85