ResearchKit / ResearchKit/ResearchKit
ORKVisualConsentStep deprecated
Nobody has claimed this yet.
- Dominant language
- Objective-C
- Stars
- 5.7k
- Forks
- 1.2k
- PR merge metrics
- No merged PRs in 30d
Description
It seems that ORKVisualConsentStep has been deprecated. In the code, there is a reference to ORKInstructionStep that should be used instead, but this one is not taking a ConsentDocument as argument. Note that ORKConsentReviewStep is still there (and accepts a ConsentDocument). Also, in the code comments, there are still some references to ORKVisualConsentStep, which is a little confusing. Could you give us any example of how to best replace the deprecated ORKVisualConsentStep with the new practise? Do I need to break down whatever is defined in the ConsentDocument into many ORKInstructionSteps? Many thanks!
Contributor guide
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
Review the APIs and comments for ORKVisualConsentStep, ORKInstructionStep, ORKConsentReviewStep, and ConsentDocument to understand the intended replacement. Document an example of the recommended consent flow, clarify whether ConsentDocument content must be split into ORKInstructionSteps, and remove or update confusing ORKVisualConsentStep references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- objective-c
- Domain
- documentation, mobile-dev
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100