datatheorem / datatheorem/TrustKit-Android
Clarify setting up TrustKit in the docs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 604
- Forks
- 90
- Avg merge
- 1h 29m
- Merged PRs (30d)
- 2
Description
Is your feature request related to a problem? Please describe.
We just ran into the problem described in #21: when the main activity's onCreate is called a second time an IllegalStateException is thrown. The solution described in the issue works, but I think this can be avoided.
Describe the solution you'd like
Make it clearer in the Getting Started docs in the "Initializing TrustKit with the Pinning Policy" section that the code snippet applies to the Application's onCreate method, rather than the MainActivity's method.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/getting-started.md, in the “Initializing TrustKit with the Pinning Policy” section. Clarify that the snippet belongs in the Application's onCreate method rather than MainActivity's, and confirm the wording addresses the repeated onCreate issue described in #21.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android, java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100