Shopify / Shopify/deprecation_toolkit
Include stacktrace in record behavior
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 538
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the record DeprecationBehavior removes the stacktrace from the deprecation message before writing to YAML- https://github.com/Shopify/deprecation_toolkit/blob/main/lib/deprecation_toolkit/behaviors/record.rb#L11
This stacktrace is pretty useful info but it is removed from the YAML content - https://github.com/Shopify/deprecation_toolkit/blob/main/lib/deprecation_toolkit/collector.rb#L36
I am willing to submit a pull request that can change the behaviour, but would like to confirm why this done.
@Edouard-chin @rafaelfranca
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 by reading lib/deprecation_toolkit/behaviors/record.rb#L11 and lib/deprecation_toolkit/collector.rb#L36 to understand where the stacktrace is removed and why. Confirm the intended behavior with the issue discussion before changing anything; done means the recorded YAML retains the useful stacktrace without breaking existing deprecation recording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100