diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 334d55bd1..5342edb37 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,6 +33,7 @@ of contribution and appreciate your help. Here are a few examples of what we consider a contribution: - Updates to source code +- Answering questions and chatting with the community in the [Gitter](https://gitter.im/postlight/mercury) room - Filing, organizing, and commenting on issues in the [issue tracker](https://github.com/postlight/mercury-parser/issues) - Teaching others how to use Mercury - Community building and outreach @@ -55,7 +56,7 @@ and filling out the template. If you find a security bug in Mercury, send an email with a descriptive subject line to [mercury+security@postlight.com](mailto:mercury+security@postlight.com). If you think -you’ve found a serious vulnerability, please do not file a public issue. +you’ve found a serious vulnerability, please do not file a public issue or share in the Mercury Gitter room. Your report will go to Mercury's core development team. You will receive acknowledgement of the report in 24-48 hours, and our next steps should be to @@ -219,6 +220,7 @@ Some useful places to look for information are: - The main [README](./README.md) for this repository. - The Mercury Custom Parser [README](./src/extractors/custom/README.md). +- The postlight/mercury room on [Gitter](https://gitter.im/postlight/mercury) - The Mercury Parser API [repository](https://github.com/postlight/mercury-parser-api). _Adapted from [Contributing to Node.js](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md) diff --git a/README.md b/README.md index 2f40145de..6708bb876 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,8 @@ Licensed under either of the below, at your preference: ## Contributing +For details on how to contribute to Mercury, including how to write a custom content extractor for any site, see [CONTRIBUTING.md](https://github.com/postlight/mercury-parser/blob/master/CONTRIBUTING.md) + Unless it is explicitly stated otherwise, any contribution intentionally submitted for inclusion in the work, as defined in the Apache-2.0 license, shall be dual licensed as above without any additional terms or conditions. ## Contributors