-
Notifications
You must be signed in to change notification settings - Fork 454
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
16 changed files
with
144 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
# The Mercury Code of Conduct | ||
# The Postlight Parser Code of Conduct | ||
|
||
## Conduct | ||
|
||
**Contact Mercury moderators:** [[email protected]](mailto:[email protected]) | ||
**Contact Postlight Parser moderators:** [[email protected]](mailto:[email protected]) | ||
|
||
- We are committed to providing a friendly, safe and welcoming environment for | ||
all, regardless of level of experience, gender, gender identity and expression, | ||
|
@@ -31,7 +31,7 @@ | |
|
||
- Private harassment is also unacceptable. No matter who you are, if you feel | ||
you have been or are being harassed or made uncomfortable by a community member, | ||
please contact one of the channel ops or any of the [Mercury moderation team](mailto:[email protected]) | ||
please contact one of the channel ops or any of the [Postlight Parser moderation team](mailto:[email protected]) | ||
immediately. Whether you're a regular contributor or a newcomer, we care about | ||
making this community a safe place for you and we've got your back. | ||
|
||
|
@@ -41,9 +41,9 @@ | |
## Moderation | ||
|
||
These are the policies for upholding our community's standards of conduct. If you | ||
feel that a thread needs moderation, please contact the [Mercury moderation team](mailto:[email protected]). | ||
feel that a thread needs moderation, please contact the [Postlight Parser moderation team](mailto:[email protected]). | ||
|
||
1. Remarks that violate the Mercury standards of conduct, including hateful, hurtful, | ||
1. Remarks that violate the Postlight Parser standards of conduct, including hateful, hurtful, | ||
oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but | ||
never targeting another user, and never in a hateful manner.) | ||
|
||
|
@@ -69,7 +69,7 @@ feel that a thread needs moderation, please contact the [Mercury moderation team | |
moderator creates an inappropriate situation, they should expect less leeway than | ||
others. | ||
|
||
In the Mercury community we strive to go the extra step to look out for each other. | ||
In the Postlight Parser community we strive to go the extra step to look out for each other. | ||
Don't just aim to be technically unimpeachable, try to be your best self. In | ||
particular, avoid flirting with offensive or sensitive issues, particularly if | ||
they're off-topic; this all too often leads to unnecessary fights, hurt feelings, | ||
|
@@ -84,9 +84,9 @@ are all here first and foremost because we want to talk about cool technology. | |
You will find that people will be eager to assume good intent and forgive as long | ||
as you earn their trust. | ||
|
||
The enforcement policies listed above apply to all official Mercury venues; including GitHub | ||
repositories under postlight/mercury such as mercury-rs and other Postlight repositories | ||
with a \*-mercury or mercury-\* naming convention; For other projects adopting the Mercury | ||
The enforcement policies listed above apply to all official Postlight Parser venues; including GitHub | ||
repositories under postlight/parser such as mercury-rs and other Postlight repositories | ||
with a \*-parser or parser-\* naming convention; For other projects adopting the Postlight Parser | ||
Code of Conduct, please contact the maintainers of those projects for enforcement. | ||
If you wish to use this code of conduct for your own project, consider explicitly | ||
mentioning your moderation policy or making a copy with your own moderation policy | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
# Contributing to Mercury Parser | ||
# Contributing to Postlight Parser | ||
|
||
Thank you for your interest in contributing to Mercury Parser! It's people like you that make Mercury such a useful tool. The below guidelines will help answer any questions you may have about the contribution process. We look forward to receiving contributions from you — our community! | ||
Thank you for your interest in contributing to Postlight Parser! It's people like you that make this such a useful tool. The below guidelines will help answer any questions you may have about the contribution process. We look forward to receiving contributions from you — our community! | ||
|
||
_Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) before participating._ | ||
|
||
## Contents | ||
|
||
- [Contributing to Mercury Parser](#contributing-to-mercury-parser) | ||
- [Contributing to Postlight Parser](#contributing-to-postlight-parser) | ||
- [Contents](#contents) | ||
- [Ways to Contribute](#ways-to-contribute) | ||
- [Reporting a Bug](#reporting-a-bug) | ||
|
@@ -27,15 +27,15 @@ _Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) before participating._ | |
|
||
## Ways to Contribute | ||
|
||
There are many ways you can contribute to the Mercury community. We value each type | ||
There are many ways you can contribute to the Postlight Parser community. We value each type | ||
of contribution and appreciate your help. | ||
|
||
Here are a few examples of what we consider a contribution: | ||
|
||
- Updates to source code, including bug fixes, improvements, or [creating new custom site extractors](./src/extractors/custom/README.md) | ||
- 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 | ||
- Filing, organizing, and commenting on issues in the [issue tracker](https://github.com/postlight/parser/issues) | ||
- Teaching others how to use Postlight Parser | ||
- Community building and outreach | ||
|
||
## Reporting a Bug | ||
|
@@ -49,41 +49,41 @@ as it's possible that someone else has already reported the error. This doesn't | |
always work, and sometimes it's hard to know what to search for, so consider | ||
this extra credit. We won't mind if you accidentally file a duplicate report. | ||
|
||
Opening an issue is as easy as following [this link](https://github.com/postlight/mercury-parser/issues/new) | ||
Opening an issue is as easy as following [this link](https://github.com/postlight/parser/issues/new) | ||
and filling out the template. | ||
|
||
### Security | ||
|
||
If you find a security bug in Mercury, send an email with a descriptive subject line | ||
If you find a security bug in Postlight Parser, send an email with a descriptive subject line | ||
to [[email protected]](mailto:[email protected]). If you think | ||
you’ve found a serious vulnerability, please do not file a public issue or share in the Mercury Gitter room. | ||
you’ve found a serious vulnerability, please do not file a public issue or share in the Postlight Parser Gitter room. | ||
|
||
Your report will go to Mercury's core development team. You will receive | ||
Your report will go to Postlight Parser's core development team. You will receive | ||
acknowledgement of the report in 24-48 hours, and our next steps should be to | ||
release a fix. If you don’t get a report acknowledgement in 48 hours, send an email to | ||
[[email protected]](mailto:[email protected]). | ||
|
||
A working list of public, known security-related issues can be found in the | ||
[issue tracker](https://github.com/postlight/mercury-parser/issues?q=is%3Aopen+is%3Aissue+label%3Asecurity). | ||
[issue tracker](https://github.com/postlight/parser/issues?q=is%3Aopen+is%3Aissue+label%3Asecurity). | ||
|
||
## Requesting a Feature | ||
|
||
To request a change to the way that Mercury works, please open an issue in this repository named, "Feature Request: [Your Feature Idea]," followed by your suggestion. | ||
To request a change to the way that Postlight Parser works, please open an issue in this repository named, "Feature Request: [Your Feature Idea]," followed by your suggestion. | ||
|
||
## Development Workflow | ||
|
||
This section of the document outlines how to build, run, and test Mercury locally. | ||
This section of the document outlines how to build, run, and test Postlight Parser locally. | ||
|
||
### Building | ||
|
||
To build the Mercury Parser locally, execute the following commands: | ||
To build the Postlight Parser locally, execute the following commands: | ||
|
||
```bash | ||
# Clone this repository from GitHub. | ||
git clone https://github.com/postlight/mercury-parser.git | ||
git clone https://github.com/postlight/parser.git | ||
|
||
# Navigate into the root of this repository. | ||
cd mercury-parser | ||
cd parser | ||
|
||
# Install local dependencies. | ||
yarn install | ||
|
@@ -97,7 +97,7 @@ yarn build:web | |
|
||
### Testing | ||
|
||
Mercury is a test-driven application; each component has its own test file. Tests are run for both node and web builds. Our testing frameworks are: | ||
Postlight Parser is a test-driven application; each component has its own test file. Tests are run for both node and web builds. Our testing frameworks are: | ||
|
||
- `Jest` for the node build | ||
- `Karma` for the web build | ||
|
@@ -143,9 +143,9 @@ preset. This helps keep our Markdown tidy and consistent. | |
|
||
### Node.js Version Requirements | ||
|
||
Mercury is built against Node `>= v12.8.1`. Since this is the | ||
Postlight Parser is built against Node `>= v12.8.1`. Since this is the | ||
version we run in our CI environments, we recommend you use it when working on | ||
the Mercury codebase. | ||
the codebase. | ||
|
||
If you use [nvm](https://github.com/creationix/nvm) to manage Node.js versions | ||
and zsh (like [Oh-My-ZSH](https://github.com/robbyrussell/oh-my-zsh)), you can | ||
|
@@ -176,12 +176,12 @@ load-nvmrc | |
|
||
## Writing Documentation | ||
|
||
Improvements to documentation are a great way to start contributing to Mercury. The | ||
Improvements to documentation are a great way to start contributing to Postlight Parser. The | ||
source for the official documentation are Markdown files that live in this repository. | ||
|
||
## Submitting a Pull Request | ||
|
||
Want to make a change to Mercury? Submit a pull request! We use the "fork and pull" | ||
Want to make a change to Postlight Parser? Submit a pull request! We use the "fork and pull" | ||
model [described here](https://help.github.com/articles/creating-a-pull-request-from-a-fork). | ||
|
||
**Before submitting a pull request**, please make sure: | ||
|
@@ -203,7 +203,7 @@ Commit messages should follow the format outlined below: | |
| chore | does not effect the production version of the app in any way. | | ||
| deps | add, update, or remove a dependency. | | ||
| doc | add, update, or remove documentation. no code changes. | | ||
| dx | improve the development experience of mercury core. | | ||
| dx | improve the development experience of parser core. | | ||
| feat | a feature or enhancement. can be incredibly small. | | ||
| fix | a bug fix for something that was broken. | | ||
| perf | add, update, or fix a test. | | ||
|
@@ -222,9 +222,9 @@ fall behind. Feel free to reach out to the core team if you have not received a | |
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 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). | ||
- The Postlight Parser API [repository](https://github.com/postlight/parser-api). | ||
|
||
_Adapted from [Contributing to Node.js](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md) | ||
and [ThinkUp Security and Data Privacy](http://thinkup.readthedocs.io/en/latest/install/security.html#thinkup-security-and-data-privacy)._ |
Oops, something went wrong.