chakra-core/ChakraCore

jsrt: Help US to update documentation and samples

Open

#4,286 opened on Nov 21, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (9,000 stars) (1,374 forks)batch import
Dev ExperienceWikihelp wanted

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

Tech stack
ccpp
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with ChakraCore JSRT APIBasic C/C++ knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the JSRT documentation in the ChakraCore repo and compare with the actual API implementation. Locate sample.cpp in test/native tests/ and the samples in the Chakra Samples repository. Update the documentation to reflect recent API changes and add code comments to the sample. Ensure all samples compile and run correctly.