kefranabg/readme-md-generator

Idea: Add contributors

Open

#53 opened on Jun 17, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (1,349 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (10,735 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi,

First of all, thank you for your awesome work 👍

There is a section about author. This would be cool to have a section about contributors too. all-contributors is a specification about recognizing contributors. They also have a tool that edit README.md to add contributors.

Contributor guide

Research direction
Implement a contributors section in the generated README by integrating the all contributors specification and its CLI tool to automatically add contributor badges and list.
Tech stack
javascript
Domain
toolingdocumentation
Issue type
Feature
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.
1-3 hours
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
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70