docs: Cleanup CONTRIBUTING.md and DEVELOPMENT.md #5538
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5538 +/- ##
=======================================
Coverage 88.41% 88.41%
=======================================
Files 66 66
Lines 4792 4792
Branches 977 977
=======================================
Hits 4237 4237
Misses 555 555 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
||
| ## Reproducing issues | ||
|
|
||
| We recommend creating a folder named `sandbox` within this repo, and then using a child project within `sandbox` for each issue you want to repro. |
There was a problem hiding this comment.
I actually have a different repro flow. I keep a folder at ~/repos/repros as a sibling to ~/repos/mocha. It's a Git repo with a branch for each test case / reproduction. The publicly interesting ones get pushed to https://github.com/JoshuaKGoldberg/repros.
Alternately, sometimes I use ~/repos/mocha-examples to get starting reproductions. It's pretty handy.
I don't think we should recommend such a specific usage flow. Not every user is going to want this.
Proposal: how about making this more general, like saying having some folder somewhere?
.github/DEVELOPMENT.md
Outdated
| We recommend creating a folder named `sandbox` within this repo, and then using a child project within `sandbox` for each issue you want to repro. | ||
|
|
||
| `package.json` will have a reference to the local Mocha build and any options you need for your repro. | ||
| We recommend [`cross-env`](https://www.npmjs.com/package/cross-env) for applying the `DEBUG` environment variable to get detailed logs (via the [`debug`](https://www.npmjs.com/package/debug) package). |
There was a problem hiding this comment.
cross-env is only useful if you're on Windows. If you're on Mac or Linux then you can omit it.
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
|
Thanks for the review :) I'll come back to this after Christmas |
|
(Removed "waiting for author" label as, well, it doesn't feel right when the author is a maintainer!) |
PR Checklist
status: accepting prsOverview
Yes, this PR is mostly for myself :D