-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Open
Labels
area: documentationanything involving docs or mochajs.organything involving docs or mochajs.orgcore-teamissues which must be handled by Mocha's core teamissues which must be handled by Mocha's core teamstatus: accepting prsMocha can use your help with this one!Mocha can use your help with this one!
Description
Documentation Request Checklist
- I have read and agree to Mocha's Code of Conduct and Contributing Guidelines
- I have searched for related issues and issues with the
faq
label, but none matched my issue. - I want to provide a PR to resolve this
Overview
Per #5442 we currently are recommending libraries in various places:
- wiki homepage
- Spies page which recommends a should.js, a library deprecated in 2020
- Third-Party Reporters page
- probably other places too...
We should have guidelines around:
- when to mention external tools
- when to remove mentions of external tools
- lack of compatibility with latest Mocha for X months?
- tool officially deprecated?
- tool claims it will only be compatible with Mocha version X and never Mocha version X+1?
- any other reasons?
- how to remove mentions of external tools
- reach out to tool owner to confirm deprecation?
- find a suitable replacement?
- when to mark external tools as "recommended" vs just listing them
- this one is very subjective 😬 maybe we never do this? if we list it, it should be good enough, and users can decide on their own?
Acceptance criteria for closing this issue:
- all pages with recommendations identified
- old recommendations reviewed and updated
- removed during review
- re-added if approved by Mocha maintainers following new guidelines
- easily-discoverable callout "Suggest new tools on Discord" or similar. No formal template needed. Make it clear this isn't a sponsor thing, it's just based on whether the tool is useful and well-maintained
Additional Info
JoshuaKGoldberg
Metadata
Metadata
Assignees
Labels
area: documentationanything involving docs or mochajs.organything involving docs or mochajs.orgcore-teamissues which must be handled by Mocha's core teamissues which must be handled by Mocha's core teamstatus: accepting prsMocha can use your help with this one!Mocha can use your help with this one!
Type
Projects
Status
No status