kshitij10496/hercules

Improve README

Open

#7 opened on Oct 17, 2018

View on GitHub
 (6 comments) (1 reaction) (0 assignees)Go (18 forks)auto 404
documentationhacktoberfest

Repository metrics

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

Description

  • Add development guidelines to setup a local environment in a host machine and a docker container.
  • Add examples.

Contributor guide

Research direction
Read the current README and project setup to draft development guidelines for both host machine and Docker. Include example usage or API calls.
Tech stack
go
Domain
documentation
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.
90