TheSpyder/rescript-webapi

Write a migration guide for 1.0

Open

#58 opened on Dec 6, 2021

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)ReScript (38 forks)github user discovery
documentationhelp wanted

Repository metrics

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

Description

Moving from bs-webapi to rescript-webapi 1.0 won't be a drop-in replacement. We need a migration guide, and I think we need to highlight it at the top of our readme file.

I'm going to make notes in comments to this issue.

Contributor guide

Research direction
Read the comments in this issue, understand the changes between bs webapi and rescript webapi 1.0, and write a migration guide highlighting the differences. Place it at the top of the README.
Tech stack
javascript
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60