docs: add steps to package packages and reference for local development #2437
Conversation
zimeg
requested review from
hello-ashleyintech,
lukegalbraithrussell,
mwbrooks and
srtaalej
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2437 +/- ##
=======================================
Coverage 93.02% 93.02%
=======================================
Files 40 40
Lines 11127 11127
Branches 713 713
=======================================
Hits 10351 10351
Misses 764 764
Partials 12 12
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
📬 A note to kind reviewers from before now!
|
|
||
| We have included `launch.json` files that store configuration for `vscode` debugging in each package. This allows you to set breakpoints in test files and interactively debug. Open the project in `vscode` and navigate to the debug screen on the left sidebar. The icon for it looks like a little lock bug with an x inside. At the top in `vscode`, select the configuration to run and press the green play icon to start debugging. Alternatively, on mac, you can press `cmd + shift + d` to get to the debug screen and `F5` to start debugging. If you are using `vscode` debugging, don't forget to lint the source (`npm run lint`) manually. | ||
|
|
||
| ### 🧰 Local Development |
There was a problem hiding this comment.
👁️🗨️ note: Hoping to have similar reference as @slack/bolt reference:
🔗 https://github.com/slackapi/bolt-js/blob/main/.github/maintainers_guide.md#local-development
There was a problem hiding this comment.
🪬 praise: Thanks too to @srtaalej for suggesting these addition!
|
@WilliamBergamin I share celebration for perhaps more clear commands and kind reminders! 📚 ✨ |
Summary
This PR updates the maintainer's guide with instructions to compile and install packages and documentation for local development! 📚
Requirements