zenika-open-source/FAQ

Add a contributing guide

Open

#211 opened on Aug 1, 2019

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (16 forks)auto 404
documentationgood first issuepriority/high

Repository metrics

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

Description

It would be nice to have a CONTRIBUTING file to help new comers to make their first contribution and enforce good practises.

Contributor guide

Research direction
Create a CONTRIBUTING.md file following the Open Source Guide's recommendations. Include sections on how to report bugs, suggest features, submit pull requests, and coding standards.
Tech stack
None
Domain
developer experiencedocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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.
95