manrajgrover/py-spinners

Documentation: Convert README from markdown to reStructuredText for pypi

Open

#13 opened on Oct 24, 2017

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (17 forks)github user discovery
documentationhacktoberfest

Repository metrics

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

Description

Description

Currently, README is in markdown which is not supported by pypi. We need to convert the file to reStructuredText for pypi. This can be automated.

People to notify

None

Contributor guide

Research direction
Convert the README.md file to reStructuredText (.rst) format. Use a tool like 'pandoc' to automate the conversion. Then update setup.py to point to the new file for long description.
Tech stack
python
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.
Under 1 hour
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
PythonreStructuredText
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90