hirosystems / stacks.js

JavaScript libraries for identity, auth, storage and transactions on the Stacks blockchain.
https://stacks.js.org
MIT License
944 stars 307 forks source link

docs: add migration docs #1649

Closed janniks closed 4 months ago

janniks commented 4 months ago

[next]

Adds content to the MIGRATION.md document in the repo.

vercel[bot] commented 4 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
stacksjs-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 7, 2024 4:04pm
janniks commented 4 months ago

As for todos, yes there will be follow up work here. I'll rename the Api helper to Client, and some other stuff. Happy to address sooner if you like 😉

In general, I usually treat todo comments like notes. Everyone that comes across them can decide to fix them or decide not to. They can be like accepted debt. If it's critical, I'll open an issue or note elsewhere. I do like the minimal burden of noting down a comment in code when already there. If there's more overhead (adding an issue, etc. tagging issue number, idk) from experience, people are discouraged from leaving their thoughts. Many times I've come back to a codebase and learned something I had completely forgotten from my own todo comments 😅 Maybe doesn't apply to this PR though 🤷‍♂