lspitzner/brittany

Document of configs

Open

#145 opened on May 22, 2018

View on GitHub
 (1 comment) (13 reactions) (0 assignees)Haskell (63 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (582 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I think it'll be nice if there's a document for config.yaml. I hope you'll consider this.

Contributor guide

Research direction
Study the existing config.yaml structure and write a documentation page describing each configuration option.
Tech stack
haskell
Domain
developer experience
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.
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
GitHaskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90