Skip to content

Commit 2845a1b

Browse files
george-haddadadampash
authored andcommitted
docs: add gitter room text and link (#235)
1 parent 380196b commit 2845a1b

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ of contribution and appreciate your help.
3333
Here are a few examples of what we consider a contribution:
3434

3535
- Updates to source code
36+
- Answering questions and chatting with the community in the [Gitter](https://gitter.im/postlight/mercury) room
3637
- Filing, organizing, and commenting on issues in the [issue tracker](https://github.com/postlight/mercury-parser/issues)
3738
- Teaching others how to use Mercury
3839
- Community building and outreach
@@ -55,7 +56,7 @@ and filling out the template.
5556

5657
If you find a security bug in Mercury, send an email with a descriptive subject line
5758
to [mercury+security@postlight.com](mailto:mercury+security@postlight.com). If you think
58-
you’ve found a serious vulnerability, please do not file a public issue.
59+
you’ve found a serious vulnerability, please do not file a public issue or share in the Mercury Gitter room.
5960

6061
Your report will go to Mercury's core development team. You will receive
6162
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:
219220

220221
- The main [README](./README.md) for this repository.
221222
- The Mercury Custom Parser [README](./src/extractors/custom/README.md).
223+
- The postlight/mercury room on [Gitter](https://gitter.im/postlight/mercury)
222224
- The Mercury Parser API [repository](https://github.com/postlight/mercury-parser-api).
223225

224226
_Adapted from [Contributing to Node.js](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md)

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ Licensed under either of the below, at your preference:
6565

6666
## Contributing
6767

68+
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)
69+
6870
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.
6971

7072
## Contributors

0 commit comments

Comments
 (0)