Bjoren/ResearchMap

Document API in wiki

Open

#25 opened on May 23, 2019

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (0 forks)auto 404
enhancementgood first issuequality assurance

Repository metrics

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

Description

The API endpoints and data models should be documented and maintained in the git wiki.

Contributor guide

Research direction
Examine the existing API implementation in the codebase, then create a wiki page documenting the endpoints, request/response formats, and data models.
Tech stack
javascript
Domain
backenddocumentation
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.
Fresh
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