{"action":"created","comment":{"url":"https://api.github.com/repos/cherow/cherow/pulls/comments/197630526","pull_request_review_id":131414000,"id":197630526,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDE5NzYzMDUyNg==","diff_hunk":"@@ -1,19 +1,200 @@\n # Contribution Guide\n \n-This page describes how to contribute changes to Cherow.\n+If you want to contribute to an Cherow repo, please use a GitHub pull request. This is the fastest way for us to evaluate your code and to merge it into the code base. Please don't file an issue with snippets of code. Doing so means that we need to manually merge the changes in and update any appropriate tests. That decreases the likelihood that your code is going to get included in a timely manner. Please use pull requests.\n \n Please do **not** create a pull request without reading this guide first. Failure to do so may result in the **rejection** of the pull request.\n And also keep in mind that performance is the main priority. The \"fastest\" way to solve an issue, isn't the fastest one, but the slowest one!\n \n-**1. Create a ticket in the [issue tracker](https://github.com/cherow/cherow/issues)**.\n-This serves as a placeholder for important feedback, review, or any future updates.\n+## Set up a development environment\n \n-**2. Run all the tests**. This requires Node.js: `npm install` to set up, `npm test` to run the tests.\n+If you'd like to work on a pull request and you've never submitted code before, follow these steps:\n \n-**3. Work on a feature branch**.  If the change still needs some tweaks, it will not clutter the master branch.\n+### Step 1: Install Node.js\n \n-**4. Write a reasonable commit message:**\n+Go to <https://nodejs.org/> to download and install the latest stable version for your operating system.\n \n-* Keep the first line < 72 characters. Write additional paragraphs if necessary.\n-* Put the link to the ticket. This is important for cross-referencing purposes.\n+Most of the installers come with [npm](https://www.npmjs.com/) already installed, but if for some reason it doesn't work on your system, you can install it manually using the instructions on the site.\n \n+### Step 2: Fork and checkout your own Cherow repository\n+\n+Go to <https://github.com/cherow/cherow> and click the \"Fork\" button. Follow the [GitHub documentation](https://help.github.com/articles/fork-a-repo) for forking and cloning.\n+\n+Once you've cloned the repository, run `npm install` to get all the necessary dependencies:\n+\n+```\n+$ cd cherow\n+$ npm install\n+```\n+\n+You must be connected to the Internet for this step to work. You'll see a lot of utilities being downloaded.\n+\n+### Step 3: Add the upstream source\n+\n+The *upstream source* is the main Cherow repository that active development happens on. While you won't have push access to upstream, you will have pull access, allowing you to pull in the latest code whenever you want.\n+\n+To add the upstream source for Cherow, run the following in your repository:\n+\n+```\n+git remote add upstream git@github.com:cherow/cherow.git\n+```\n+\n+Now, the remote `upstream` points to the upstream source.\n+\n+### Step 4: Run the tests\n+\n+Running the tests is the best way to ensure you have correctly set up your development environment. Make sure you're in the `cherow` directory and run:\n+\n+```\n+npm test","path":".github/CONTRIBUTING.md","position":56,"original_position":56,"commit_id":"7944bdeb61f08a4e94d351ce69cd5d0cc967c1b9","original_commit_id":"7944bdeb61f08a4e94d351ce69cd5d0cc967c1b9","user":{"login":"g-plane","id":17216317,"node_id":"MDQ6VXNlcjE3MjE2MzE3","avatar_url":"https://avatars1.githubusercontent.com/u/17216317?v=4","gravatar_id":"","url":"https://api.github.com/users/g-plane","html_url":"https://github.com/g-plane","followers_url":"https://api.github.com/users/g-plane/followers","following_url":"https://api.github.com/users/g-plane/following{/other_user}","gists_url":"https://api.github.com/users/g-plane/gists{/gist_id}","starred_url":"https://api.github.com/users/g-plane/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/g-plane/subscriptions","organizations_url":"https://api.github.com/users/g-plane/orgs","repos_url":"https://api.github.com/users/g-plane/repos","events_url":"https://api.github.com/users/g-plane/events{/privacy}","received_events_url":"https://api.github.com/users/g-plane/received_events","type":"User","site_admin":false},"body":"To make it work, we should update the root `package.json` file. (Not in this PR)","created_at":"2018-06-24T07:14:44Z","updated_at":"2018-06-24T07:15:41Z","html_url":"https://github.com/cherow/cherow/pull/165#discussion_r197630526","pull_request_url":"https://api.github.com/repos/cherow/cherow/pulls/165","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/cherow/cherow/pulls/comments/197630526"},"html":{"href":"https://github.com/cherow/cherow/pull/165#discussion_r197630526"},"pull_request":{"href":"https://api.github.com/repos/cherow/cherow/pulls/165"}}},"pull_request":{"url":"https://api.github.com/repos/cherow/cherow/pulls/165","id":196883004,"node_id":"MDExOlB1bGxSZXF1ZXN0MTk2ODgzMDA0","html_url":"https://github.com/cherow/cherow/pull/165","diff_url":"https://github.com/cherow/cherow/pull/165.diff","patch_url":"https://github.com/cherow/cherow/pull/165.patch","issue_url":"https://api.github.com/repos/cherow/cherow/issues/165","number":165,"state":"open","locked":false,"title":"wip: docs(*): add contributing.md","user":{"login":"Aladdin-ADD","id":13050025,"node_id":"MDQ6VXNlcjEzMDUwMDI1","avatar_url":"https://avatars2.githubusercontent.com/u/13050025?v=4","gravatar_id":"","url":"https://api.github.com/users/Aladdin-ADD","html_url":"https://github.com/Aladdin-ADD","followers_url":"https://api.github.com/users/Aladdin-ADD/followers","following_url":"https://api.github.com/users/Aladdin-ADD/following{/other_user}","gists_url":"https://api.github.com/users/Aladdin-ADD/gists{/gist_id}","starred_url":"https://api.github.com/users/Aladdin-ADD/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Aladdin-ADD/subscriptions","organizations_url":"https://api.github.com/users/Aladdin-ADD/orgs","repos_url":"https://api.github.com/users/Aladdin-ADD/repos","events_url":"https://api.github.com/users/Aladdin-ADD/events{/privacy}","received_events_url":"https://api.github.com/users/Aladdin-ADD/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-06-23T05:24:16Z","updated_at":"2018-06-24T07:15:41Z","closed_at":null,"merged_at":null,"merge_commit_sha":"579d663a511beb127bc311a1e5e15c8b525b976c","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":960331358,"node_id":"MDU6TGFiZWw5NjAzMzEzNTg=","url":"https://api.github.com/repos/cherow/cherow/labels/do%20not%20merge","name":"do not merge","color":"b60205","default":false},{"id":963537943,"node_id":"MDU6TGFiZWw5NjM1Mzc5NDM=","url":"https://api.github.com/repos/cherow/cherow/labels/documentation","name":"documentation","color":"5acbf4","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/cherow/cherow/pulls/165/commits","review_comments_url":"https://api.github.com/repos/cherow/cherow/pulls/165/comments","review_comment_url":"https://api.github.com/repos/cherow/cherow/pulls/comments{/number}","comments_url":"https://api.github.com/repos/cherow/cherow/issues/165/comments","statuses_url":"https://api.github.com/repos/cherow/cherow/statuses/7944bdeb61f08a4e94d351ce69cd5d0cc967c1b9","head":{"label":"Aladdin-ADD:docs/contributing","ref":"docs/contributing","sha":"7944bdeb61f08a4e94d351ce69cd5d0cc967c1b9","user":{"login":"Aladdin-ADD","id":13050025,"node_id":"MDQ6VXNlcjEzMDUwMDI1","avatar_url":"https://avatars2.githubusercontent.com/u/13050025?v=4","gravatar_id":"","url":"https://api.github.com/users/Aladdin-ADD","html_url":"https://github.com/Aladdin-ADD","followers_url":"https://api.github.com/users/Aladdin-ADD/followers","following_url":"https://api.github.com/users/Aladdin-ADD/following{/other_user}","gists_url":"https://api.github.com/users/Aladdin-ADD/gists{/gist_id}","starred_url":"https://api.github.com/users/Aladdin-ADD/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Aladdin-ADD/subscriptions","organizations_url":"https://api.github.com/users/Aladdin-ADD/orgs","repos_url":"https://api.github.com/users/Aladdin-ADD/repos","events_url":"https://api.github.com/users/Aladdin-ADD/events{/privacy}","received_events_url":"https://api.github.com/users/Aladdin-ADD/received_events","type":"User","site_admin":false},"repo":{"id":136774277,"node_id":"MDEwOlJlcG9zaXRvcnkxMzY3NzQyNzc=","name":"cherow","full_name":"Aladdin-ADD/cherow","owner":{"login":"Aladdin-ADD","id":13050025,"node_id":"MDQ6VXNlcjEzMDUwMDI1","avatar_url":"https://avatars2.githubusercontent.com/u/13050025?v=4","gravatar_id":"","url":"https://api.github.com/users/Aladdin-ADD","html_url":"https://github.com/Aladdin-ADD","followers_url":"https://api.github.com/users/Aladdin-ADD/followers","following_url":"https://api.github.com/users/Aladdin-ADD/following{/other_user}","gists_url":"https://api.github.com/users/Aladdin-ADD/gists{/gist_id}","starred_url":"https://api.github.com/users/Aladdin-ADD/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Aladdin-ADD/subscriptions","organizations_url":"https://api.github.com/users/Aladdin-ADD/orgs","repos_url":"https://api.github.com/users/Aladdin-ADD/repos","events_url":"https://api.github.com/users/Aladdin-ADD/events{/privacy}","received_events_url":"https://api.github.com/users/Aladdin-ADD/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/Aladdin-ADD/cherow","description":"Very fast and lightweight, standards-compliant, self-hosted javascript parser with high focus on both performance and stability","fork":true,"url":"https://api.github.com/repos/Aladdin-ADD/cherow","forks_url":"https://api.github.com/repos/Aladdin-ADD/cherow/forks","keys_url":"https://api.github.com/repos/Aladdin-ADD/cherow/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Aladdin-ADD/cherow/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Aladdin-ADD/cherow/teams","hooks_url":"https://api.github.com/repos/Aladdin-ADD/cherow/hooks","issue_events_url":"https://api.github.com/repos/Aladdin-ADD/cherow/issues/events{/number}","events_url":"https://api.github.com/repos/Aladdin-ADD/cherow/events","assignees_url":"https://api.github.com/repos/Aladdin-ADD/cherow/assignees{/user}","branches_url":"https://api.github.com/repos/Aladdin-ADD/cherow/branches{/branch}","tags_url":"https://api.github.com/repos/Aladdin-ADD/cherow/tags","blobs_url":"https://api.github.com/repos/Aladdin-ADD/cherow/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Aladdin-ADD/cherow/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Aladdin-ADD/cherow/git/refs{/sha}","trees_url":"https://api.github.com/repos/Aladdin-ADD/cherow/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Aladdin-ADD/cherow/statuses/{sha}","languages_url":"https://api.github.com/repos/Aladdin-ADD/cherow/languages","stargazers_url":"https://api.github.com/repos/Aladdin-ADD/cherow/stargazers","contributors_url":"https://api.github.com/repos/Aladdin-ADD/cherow/contributors","subscribers_url":"https://api.github.com/repos/Aladdin-ADD/cherow/subscribers","subscription_url":"https://api.github.com/repos/Aladdin-ADD/cherow/subscription","commits_url":"https://api.github.com/repos/Aladdin-ADD/cherow/commits{/sha}","git_commits_url":"https://api.github.com/repos/Aladdin-ADD/cherow/git/commits{/sha}","comments_url":"https://api.github.com/repos/Aladdin-ADD/cherow/comments{/number}","issue_comment_url":"https://api.github.com/repos/Aladdin-ADD/cherow/issues/comments{/number}","contents_url":"https://api.github.com/repos/Aladdin-ADD/cherow/contents/{+path}","compare_url":"https://api.github.com/repos/Aladdin-ADD/cherow/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Aladdin-ADD/cherow/merges","archive_url":"https://api.github.com/repos/Aladdin-ADD/cherow/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Aladdin-ADD/cherow/downloads","issues_url":"https://api.github.com/repos/Aladdin-ADD/cherow/issues{/number}","pulls_url":"https://api.github.com/repos/Aladdin-ADD/cherow/pulls{/number}","milestones_url":"https://api.github.com/repos/Aladdin-ADD/cherow/milestones{/number}","notifications_url":"https://api.github.com/repos/Aladdin-ADD/cherow/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Aladdin-ADD/cherow/labels{/name}","releases_url":"https://api.github.com/repos/Aladdin-ADD/cherow/releases{/id}","deployments_url":"https://api.github.com/repos/Aladdin-ADD/cherow/deployments","created_at":"2018-06-10T02:49:46Z","updated_at":"2018-06-23T04:55:02Z","pushed_at":"2018-06-24T07:10:54Z","git_url":"git://github.com/Aladdin-ADD/cherow.git","ssh_url":"git@github.com:Aladdin-ADD/cherow.git","clone_url":"https://github.com/Aladdin-ADD/cherow.git","svn_url":"https://github.com/Aladdin-ADD/cherow","homepage":"","size":19134,"stargazers_count":0,"watchers_count":0,"language":"TypeScript","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"isc","name":"ISC License","spdx_id":"ISC","url":"https://api.github.com/licenses/isc","node_id":"MDc6TGljZW5zZTEw"},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"cherow:master","ref":"master","sha":"fa71b0dfd69385600b57fad8f8badc8e1824ed36","user":{"login":"cherow","id":31855416,"node_id":"MDEyOk9yZ2FuaXphdGlvbjMxODU1NDE2","avatar_url":"https://avatars1.githubusercontent.com/u/31855416?v=4","gravatar_id":"","url":"https://api.github.com/users/cherow","html_url":"https://github.com/cherow","followers_url":"https://api.github.com/users/cherow/followers","following_url":"https://api.github.com/users/cherow/following{/other_user}","gists_url":"https://api.github.com/users/cherow/gists{/gist_id}","starred_url":"https://api.github.com/users/cherow/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cherow/subscriptions","organizations_url":"https://api.github.com/users/cherow/orgs","repos_url":"https://api.github.com/users/cherow/repos","events_url":"https://api.github.com/users/cherow/events{/privacy}","received_events_url":"https://api.github.com/users/cherow/received_events","type":"Organization","site_admin":false},"repo":{"id":103145619,"node_id":"MDEwOlJlcG9zaXRvcnkxMDMxNDU2MTk=","name":"cherow","full_name":"cherow/cherow","owner":{"login":"cherow","id":31855416,"node_id":"MDEyOk9yZ2FuaXphdGlvbjMxODU1NDE2","avatar_url":"https://avatars1.githubusercontent.com/u/31855416?v=4","gravatar_id":"","url":"https://api.github.com/users/cherow","html_url":"https://github.com/cherow","followers_url":"https://api.github.com/users/cherow/followers","following_url":"https://api.github.com/users/cherow/following{/other_user}","gists_url":"https://api.github.com/users/cherow/gists{/gist_id}","starred_url":"https://api.github.com/users/cherow/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cherow/subscriptions","organizations_url":"https://api.github.com/users/cherow/orgs","repos_url":"https://api.github.com/users/cherow/repos","events_url":"https://api.github.com/users/cherow/events{/privacy}","received_events_url":"https://api.github.com/users/cherow/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/cherow/cherow","description":"Very fast and lightweight, standards-compliant, self-hosted javascript parser with high focus on both performance and stability","fork":false,"url":"https://api.github.com/repos/cherow/cherow","forks_url":"https://api.github.com/repos/cherow/cherow/forks","keys_url":"https://api.github.com/repos/cherow/cherow/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cherow/cherow/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cherow/cherow/teams","hooks_url":"https://api.github.com/repos/cherow/cherow/hooks","issue_events_url":"https://api.github.com/repos/cherow/cherow/issues/events{/number}","events_url":"https://api.github.com/repos/cherow/cherow/events","assignees_url":"https://api.github.com/repos/cherow/cherow/assignees{/user}","branches_url":"https://api.github.com/repos/cherow/cherow/branches{/branch}","tags_url":"https://api.github.com/repos/cherow/cherow/tags","blobs_url":"https://api.github.com/repos/cherow/cherow/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cherow/cherow/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cherow/cherow/git/refs{/sha}","trees_url":"https://api.github.com/repos/cherow/cherow/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cherow/cherow/statuses/{sha}","languages_url":"https://api.github.com/repos/cherow/cherow/languages","stargazers_url":"https://api.github.com/repos/cherow/cherow/stargazers","contributors_url":"https://api.github.com/repos/cherow/cherow/contributors","subscribers_url":"https://api.github.com/repos/cherow/cherow/subscribers","subscription_url":"https://api.github.com/repos/cherow/cherow/subscription","commits_url":"https://api.github.com/repos/cherow/cherow/commits{/sha}","git_commits_url":"https://api.github.com/repos/cherow/cherow/git/commits{/sha}","comments_url":"https://api.github.com/repos/cherow/cherow/comments{/number}","issue_comment_url":"https://api.github.com/repos/cherow/cherow/issues/comments{/number}","contents_url":"https://api.github.com/repos/cherow/cherow/contents/{+path}","compare_url":"https://api.github.com/repos/cherow/cherow/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cherow/cherow/merges","archive_url":"https://api.github.com/repos/cherow/cherow/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cherow/cherow/downloads","issues_url":"https://api.github.com/repos/cherow/cherow/issues{/number}","pulls_url":"https://api.github.com/repos/cherow/cherow/pulls{/number}","milestones_url":"https://api.github.com/repos/cherow/cherow/milestones{/number}","notifications_url":"https://api.github.com/repos/cherow/cherow/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cherow/cherow/labels{/name}","releases_url":"https://api.github.com/repos/cherow/cherow/releases{/id}","deployments_url":"https://api.github.com/repos/cherow/cherow/deployments","created_at":"2017-09-11T14:23:17Z","updated_at":"2018-06-24T05:50:48Z","pushed_at":"2018-06-24T07:10:56Z","git_url":"git://github.com/cherow/cherow.git","ssh_url":"git@github.com:cherow/cherow.git","clone_url":"https://github.com/cherow/cherow.git","svn_url":"https://github.com/cherow/cherow","homepage":"","size":19033,"stargazers_count":1092,"watchers_count":1092,"language":"TypeScript","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":34,"mirror_url":null,"archived":false,"open_issues_count":15,"license":{"key":"isc","name":"ISC License","spdx_id":"ISC","url":"https://api.github.com/licenses/isc","node_id":"MDc6TGljZW5zZTEw"},"forks":34,"open_issues":15,"watchers":1092,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/cherow/cherow/pulls/165"},"html":{"href":"https://github.com/cherow/cherow/pull/165"},"issue":{"href":"https://api.github.com/repos/cherow/cherow/issues/165"},"comments":{"href":"https://api.github.com/repos/cherow/cherow/issues/165/comments"},"review_comments":{"href":"https://api.github.com/repos/cherow/cherow/pulls/165/comments"},"review_comment":{"href":"https://api.github.com/repos/cherow/cherow/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/cherow/cherow/pulls/165/commits"},"statuses":{"href":"https://api.github.com/repos/cherow/cherow/statuses/7944bdeb61f08a4e94d351ce69cd5d0cc967c1b9"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"g-plane"}}