☕️ Classic, reliable, trusted test framework for Node.js and the browser
update README.md; closes #3191 [ci skip]
Christopher Hiller0542c407fcc0
diff --git a/README.md b/README.mdindex a118407c..9655920d 100644--- a/README.md+++ b/README.md@@ -1,39 +1,3 @@-# Mocha needs YOU!--*Did you know* Mocha [is a dependency of over 100,000 projects](https://libraries.io/npm/mocha) published to npm alone?--**Despite this, we're currently unable to merge most pull requests due to lack of maintenance resources.**--**Are you interested in triaging issues or reviewing open PRs? Have some time to hack on its codebase?** If you would like to help maintain Mocha, please contact `@boneskull` on [Gitter](https://gitter.im/mochajs/mocha).--*Thank you* :kissing_heart: to all of you interested in helping. These are Mocha's immediate needs:--1. Increase test coverage on Node.js and browser- - Increase integration coverage for all reporters- - `html` reporter must be tested in browser- - ~~Basic console reporters (*not* `nyan`, `landing`, etc.) must be tested in **both** browser and Node.js contexts~~- - ~~Filesystem-based reporters must be tested in Node.js context~~- - **UPDATE - May 24 2017**: Thanks to [community contributions](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md#mag-coverage), the coverage on most reporters has increased dramatically! The `html` reporter is still in [dire need of coverage](https://coveralls.io/builds/11674428/source?filename=lib%2Freporters%2Fhtml.js).- - Increase coverage against all interfaces (`exports` in particular). Ideally this becomes a "matrix" where we repeat sets of integration tests across all interfaces.- - Refactor non-Node.js-specific tests to allow them to run in a browser context. Node.js-specific tests include those which *require* the CLI or filesystem. Most everything else is fair game.-1. Review current open pull requests- - We need individuals familiar with Mocha's codebase. Got questions? Ask them in [our chat room](https://gitter.im/mochajs/mocha).- - Pull requests **must** have supporting tests. The only exceptions are pure cosmetic or non-functional changes.- - Pull request contributors must sign [the CLA](https://cla.js.foundation/mochajs/mocha).-1. Close old, inactive issues and pull requests- - ~~A bot should do this. We need a bot. Got a bot?~~ We now use GitHub's own [probot-stale](https://www.npmjs.com/package/probot-stale).-1. Triage issues- - If we run into "critical" bugs, they need fixing.- - "Critical" means Mocha is broken w/o workarounds for a *large percentage* of users- - Otherwise: respond to issues, close new dupe issues, confirm bugs, ask for more info, etc.--Once we gain ground on the above items, we can work together formalize our contribution guidelines and governance. For further info & ideas, please see our [projects](https://github.com/mochajs/mocha/projects/).--*You needn't be a maintainer to submit a pull request for test coverage!*---- @boneskull, *Jan 17 2016*--<br><br><p align="center"><img src="https://cldup.com/xFVFxOioAU.svg" alt="Mocha test framework"/></p>@@ -47,11 +11,12 @@ Once we gain ground on the above items, we can work together formalize our contr## Links-- [Documentation](http://mochajs.org)-- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)-- [Google Group](http://groups.google.com/group/mochajs)-- [Wiki](https://github.com/mochajs/mocha/wiki)-- Mocha [Extensions and reporters](https://github.com/mochajs/mocha/wiki)+- **[Documentation](https://mochajs.org)**+- **[Release Notes / History / Changes](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)**+- [Code of Conduct](https://github.com/mochajs/mocha/blob/master/.github/CODE_OF_CONDUCT.md)+- [Gitter Chatroom](https://gitter.im/mochajs/mocha) (ask questions here!)+- [Google Group](https://groups.google.com/group/mochajs)+- [Issue Tracker](https://github.com/mochajs/mocha/issues)## Backers@@ -113,6 +78,25 @@ Does your company use Mocha? Ask your manager or marketing team if your company[](https://opencollective.com/mochajs/sponsor/18/website)[](https://opencollective.com/mochajs/sponsor/19/website)+## Development++You might want to know that:++- Mocha is the *most-depended-upon* module on npm (source: [libraries.io](https://libraries.io/search?order=desc&platforms=NPM&sort=dependents_count)), and+- Mocha is an *independent* open-source project, maintained exclusively by volunteers.++You might want to help:++- New to contributing to Mocha? Check out this list of [good first issues](https://github.com/mochajs/mocha/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue)+- Mocha could use a hand with [these issues](https://github.com/mochajs/mocha/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)+- The [maintainer's handbook](https://github.com/mochajs/mocha/blob/master/MAINTAINERS.md) explains how things get done++Finally, come [chat with the maintainers](https://gitter.im/mochajs/contributors) on Gitter if you want to help with:++- Triaging issues, answering questions+- Review, merging, and closing pull requests+- Other project-maintenance-y things+## License[MIT](LICENSE)