hasadna/migdar-search-api

Add a README.md

Open

#1 opened on Dec 9, 2018

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (0 forks)auto 404
enhancementgood first issue

Repository metrics

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

Description

Just found out from the github dashboard that @akariv created this repo. I'm missing a README with the API's documentation and a description of the sources and the backers of this project.

Contributor guide

Research direction
Write a README file describing the API endpoints, sources, and backers. Look at the existing code to understand the API structure.
Tech stack
None
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90