athityakumar/tvseries

Update README

Open

#21 opened on Dec 7, 2016

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)HTML (25 forks)github user discovery
KWoCgood first issue

Repository metrics

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

Description

  • Add screenshots of working of script on terminal, sample series page and sample home page.
  • Add more easily understandable "How to contribute" section
  • Add badges from Ruby and Travis CI

Contributor guide

Research direction
Take screenshots of the terminal output, a sample series page, and a sample home page. Add them to the README using relative paths. Also, improve the 'How to contribute' section with clear steps for forking, cloning, and making a pull request. Add Ruby and Travis CI badges from standard badge services like shields.io.
Tech stack
ruby
Domain
backend
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80