square / square/workflow-kotlin
Deprecate Worker.createSideEffect, LifecycleWorker
Open
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 1.1k
- Forks
- 112
- Avg merge
- 10h 5m
- Merged PRs (30d)
- 3
Description
They're both redundant with runningSideEffect, and the former's name makes it very confusing. Existing docs that refer to createSideEffect should point people to runningSideEffect instead.
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
Search the repository for Worker.createSideEffect, LifecycleWorker, runningSideEffect, and documentation references to createSideEffect. Review the surrounding API and docs to determine all references that need updating; done means the redundant APIs are deprecated and existing documentation points to runningSideEffect.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100