facebook/redex

Document global g_redex

Open

#204 opened on Feb 6, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (550 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (5,107 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

There's no documentation that to use libredex you need to instantiate a RedexContext and set the global g_redex to it. This should at least be documented, or refactored around.

At least now I can find out if I can do the thing I'm trying to do! :-)

Contributor guide

Research direction
Examine the RedexContext class and g redex global variable in the codebase, then document how to instantiate RedexContext and set g redex for using libredex.
Tech stack
cpp
Domain
mobile devdevtools
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
C++Knowledge of Android bytecode optimization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70