chakra-core/ChakraCore

jsrt: Help US to update documentation and samples

Open

#4,286 opened on Nov 21, 2017

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)JavaScript (1,225 forks)batch import
Dev ExperienceWikihelp wanted

Repository metrics

Stars
 (9,258 stars)
PR merge metrics
 (PR metrics pending)

Description

Recent changes, we have differences between ChakraCore JSRT docs and the actual implementation. (including the new API I have recently added)

[optional, bonus] ++ add more samples to https://github.com/Microsoft/Chakra-Samples/tree/master/ChakraCore%20Samples (move sample.cpp from this repo's test/native-tests/pick-a-sub-folder and add code comments)

EDIT: more detail and typos

Contributor guide

Research direction
Review the ChakraCore JSRT documentation and compare it with the actual source code to identify outdated parts. Then, create or update samples by moving and commenting code from existing tests to the Chakra Samples repository.
Tech stack
javascriptc
Domain
documentation
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80