kefranabg/readme-md-generator

Idea: Add contributors

Open

#53 opened on Jun 17, 2019

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

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

Tech stack
javascriptnodejs
Domain
clidocumentation
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptNode.jsall contributors
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the README generation logic in the repository, likely in the main script (e.g., index.js). Explore the all contributors CLI documentation to understand how to integrate it. Check existing comments for suggestions on implementation approach. Consider adding a new command or modifying the generator to automatically include a contributors section by running the all contributors tool.