microg / microg/SafeParcel

Should proguard keep `SafeParcelable`?

Open
#8 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Java
Stars
37
Forks
14
PR merge metrics
No merged PRs in 30d

Description

[The documentation for SafeParcel proguard](https://github.com/microg/SafeParcel/blob/master/proguard.txt) doesn't keep `SafeParcelable`. This has been causing some issues for me. I notice in a few places (like [here](https://github.com/microg/SafeParcel/blob/efb2c7f09f8f6d8cd2af295545314c1596df77a3/safe-parcel/src/main/java/org/microg/safeparcel/SafeParcelable.java#L29) and [here](https://github.com/microg/SafeParcel/blob/efb2c7f09f8f6d8cd2af295545314c1596df77a3/safe-parcel/src/main/java/org/microg/safeparcel/SafeParcelUtil.java#L142)) `SafeParcelable` is used. Configuring proguard to keep `SafeParcelable` fixes the issues for me. Should the documentation be updated?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with proguard.txt and compare its SafeParcelable rules with the uses referenced in SafeParcelable.java and SafeParcelUtil.java. Confirm whether the documented ProGuard configuration should keep SafeParcelable, then update the documentation if appropriate; no test file is mentioned.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.