{"action":"created","comment":{"url":"https://api.github.com/repos/dotnet/core-docs/pulls/comments/33723065","id":33723065,"diff_hunk":"@@ -0,0 +1,102 @@\n+Contributing\n+======\n+\n+The documentation is built using [Sphinx](http://sphinx-doc.org) and\n+[reStructuredText](http://sphinx-doc.org/rest.html), and then hosted by\n+[ReadTheDocs](http://dotnet.readthedocs.org).\n+\n+## Building the Docs\n+\n+To build the docs, you will need to install\n+[python](https://www.python.org/downloads/) (version 2 or higher). If you are\n+running Windows, you will want to add the Python install folder and the\n+\\Scripts\\ folder to your `PATH` environment variable\n+(C:\\Python34;C:\\Python34\\Scripts).\n+\n+To install Sphinx, open a command prompt and run:\n+\n+\tpip install sphinx\n+\n+This may take a few minutes.\n+\n+This project is also using a custom theme from ReadTheDocs, which you can\n+install with:\n+\n+\tpip install sphinx_rtd_theme\n+\n+Note that later if you wish to update your current, installed version of this\n+theme, you should run:\n+\n+\tpip install -U sphinx_rtd_theme\n+\n+You should now be able to navigate to the `docs` folder and run\n+\n+\tmake html\n+\n+which should generate the documentation in the _build folder. Open the\n+_build/html/index.html file to view the generated documentation.\n+\n+If contributing new documentation content, please review:\n+\n+- the [Sphinx Style Guide](http://documentation-style-guide-sphinx.readthedocs.\n+\torg/en/latest/style-guide.html)\n+\n+## Adding Content ##\n+\n+Before adding content, submit an issue with a suggestion for your proposed\n+article. Provide detail on what the article would discuss, and how it would\n+relate to existing documentation.\n+\n+Articles should be organized into logical groups or sections. Each section\n+should be given a named folder (e.g. /yourfirst). That section contains the\n+rst files for all articles in the section. For images and other static\n+resources, create a subfolder that matches the name of the article. Within this\n+subfolder, create a ``sample`` folder for code samples and a  ``_static`` folder\n+ for images and other static content.\n+\n+### Example Structure ###\n+\n+\tdocs\n+\t\t/concepts\n+    /getting-started\n+    /porting\n+      /_static\n+        portability_report.png\n+\t\t\t\t\t...\n+**Note:** Sphinx will automatically fix duplicate image names. There is no need\n+to try to ensure uniqueness of static files beyond an individual article.\n+\n+Author information is kept in _authors.txt_ file in the docs folder. The authors\n+ should be specified by a name and a link to the author's GitHub profile.\n+\n+## Process for Contributing ##\n+\n+**Step 1:** Open an Issue describing the article you wish to write and how it\n+relates to existing content. Get approval to write your article.\n+\n+**Step 2:** Fork the `/dotnet/core-docs` repo.\n+\n+**Step 3:** Create a `branch` for your article.\n+\n+**Step 4:** Write your article, placing the article in its own folder and any\n+needed images in a _static folder located in the same folder as the article.\n+Be sure to follow the proper reStructuredText syntax. If you have code samples,\n+place them in a folder within the `/samples/` folder.\n+\n+**Step 5:** Submit a Pull Request from your branch to `dotnet/core-docs/master`.\n+\n+**Step 6:** Discuss the Pull Request with the .NET team; make any requested\n+updates to your branch. When they are ready to accept the PR, they will add a\n+\"LGTM\" (Looks Good To Me) comment and any other steps that are (maybe) needed.\n+\n+## Common Pitfalls ##\n+\n+Below are some common pitfalls you should try to avoid:\n+\n+- Don't forget to submit an issue before starting work on an article\n+- Don't forget to create a separate branch before working on your article\n+- Don't update or `merge` your branch after you submit your pull request","path":"CONTRIBUTING.md","position":98,"original_position":98,"commit_id":"f3786b9c554b6d84a88382cf7deea3294a92e61a","original_commit_id":"f3786b9c554b6d84a88382cf7deea3294a92e61a","user":{"login":"blackdwarf","id":3115004,"avatar_url":"https://avatars.githubusercontent.com/u/3115004?v=3","gravatar_id":"","url":"https://api.github.com/users/blackdwarf","html_url":"https://github.com/blackdwarf","followers_url":"https://api.github.com/users/blackdwarf/followers","following_url":"https://api.github.com/users/blackdwarf/following{/other_user}","gists_url":"https://api.github.com/users/blackdwarf/gists{/gist_id}","starred_url":"https://api.github.com/users/blackdwarf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/blackdwarf/subscriptions","organizations_url":"https://api.github.com/users/blackdwarf/orgs","repos_url":"https://api.github.com/users/blackdwarf/repos","events_url":"https://api.github.com/users/blackdwarf/events{/privacy}","received_events_url":"https://api.github.com/users/blackdwarf/received_events","type":"User","site_admin":false},"body":"For ASP.NET, since they insist you squash your commits, this is valid, for us not. ","created_at":"2015-07-01T20:52:22Z","updated_at":"2015-07-01T20:52:22Z","html_url":"https://github.com/dotnet/core-docs/pull/20#discussion_r33723065","pull_request_url":"https://api.github.com/repos/dotnet/core-docs/pulls/20","_links":{"self":{"href":"https://api.github.com/repos/dotnet/core-docs/pulls/comments/33723065"},"html":{"href":"https://github.com/dotnet/core-docs/pull/20#discussion_r33723065"},"pull_request":{"href":"https://api.github.com/repos/dotnet/core-docs/pulls/20"}}},"pull_request":{"url":"https://api.github.com/repos/dotnet/core-docs/pulls/20","id":38880379,"html_url":"https://github.com/dotnet/core-docs/pull/20","diff_url":"https://github.com/dotnet/core-docs/pull/20.diff","patch_url":"https://github.com/dotnet/core-docs/pull/20.patch","issue_url":"https://api.github.com/repos/dotnet/core-docs/issues/20","number":20,"state":"open","locked":false,"title":"Contribution guidelines","user":{"login":"blackdwarf","id":3115004,"avatar_url":"https://avatars.githubusercontent.com/u/3115004?v=3","gravatar_id":"","url":"https://api.github.com/users/blackdwarf","html_url":"https://github.com/blackdwarf","followers_url":"https://api.github.com/users/blackdwarf/followers","following_url":"https://api.github.com/users/blackdwarf/following{/other_user}","gists_url":"https://api.github.com/users/blackdwarf/gists{/gist_id}","starred_url":"https://api.github.com/users/blackdwarf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/blackdwarf/subscriptions","organizations_url":"https://api.github.com/users/blackdwarf/orgs","repos_url":"https://api.github.com/users/blackdwarf/repos","events_url":"https://api.github.com/users/blackdwarf/events{/privacy}","received_events_url":"https://api.github.com/users/blackdwarf/received_events","type":"User","site_admin":false},"body":"Adding the contribution guidelines for .NET Core Conceptual docs. These \r\nwill also be reused in the CoreFX and CoreCLR repos.\r\n\r\n/cc @richlander @terrajobst @ellismg ","created_at":"2015-06-30T13:57:56Z","updated_at":"2015-07-01T20:52:22Z","closed_at":null,"merged_at":null,"merge_commit_sha":"4f224198b11dbd52c9b10a73d2d03225e0485890","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/dotnet/core-docs/pulls/20/commits","review_comments_url":"https://api.github.com/repos/dotnet/core-docs/pulls/20/comments","review_comment_url":"https://api.github.com/repos/dotnet/core-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/dotnet/core-docs/issues/20/comments","statuses_url":"https://api.github.com/repos/dotnet/core-docs/statuses/f3786b9c554b6d84a88382cf7deea3294a92e61a","head":{"label":"dotnet:contribution-guidelines","ref":"contribution-guidelines","sha":"f3786b9c554b6d84a88382cf7deea3294a92e61a","user":{"login":"dotnet","id":9141961,"avatar_url":"https://avatars.githubusercontent.com/u/9141961?v=3","gravatar_id":"","url":"https://api.github.com/users/dotnet","html_url":"https://github.com/dotnet","followers_url":"https://api.github.com/users/dotnet/followers","following_url":"https://api.github.com/users/dotnet/following{/other_user}","gists_url":"https://api.github.com/users/dotnet/gists{/gist_id}","starred_url":"https://api.github.com/users/dotnet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dotnet/subscriptions","organizations_url":"https://api.github.com/users/dotnet/orgs","repos_url":"https://api.github.com/users/dotnet/repos","events_url":"https://api.github.com/users/dotnet/events{/privacy}","received_events_url":"https://api.github.com/users/dotnet/received_events","type":"Organization","site_admin":false},"repo":{"id":35890081,"name":"core-docs","full_name":"dotnet/core-docs","owner":{"login":"dotnet","id":9141961,"avatar_url":"https://avatars.githubusercontent.com/u/9141961?v=3","gravatar_id":"","url":"https://api.github.com/users/dotnet","html_url":"https://github.com/dotnet","followers_url":"https://api.github.com/users/dotnet/followers","following_url":"https://api.github.com/users/dotnet/following{/other_user}","gists_url":"https://api.github.com/users/dotnet/gists{/gist_id}","starred_url":"https://api.github.com/users/dotnet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dotnet/subscriptions","organizations_url":"https://api.github.com/users/dotnet/orgs","repos_url":"https://api.github.com/users/dotnet/repos","events_url":"https://api.github.com/users/dotnet/events{/privacy}","received_events_url":"https://api.github.com/users/dotnet/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/dotnet/core-docs","description":".NET Core documentation (work in progress).","fork":false,"url":"https://api.github.com/repos/dotnet/core-docs","forks_url":"https://api.github.com/repos/dotnet/core-docs/forks","keys_url":"https://api.github.com/repos/dotnet/core-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dotnet/core-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dotnet/core-docs/teams","hooks_url":"https://api.github.com/repos/dotnet/core-docs/hooks","issue_events_url":"https://api.github.com/repos/dotnet/core-docs/issues/events{/number}","events_url":"https://api.github.com/repos/dotnet/core-docs/events","assignees_url":"https://api.github.com/repos/dotnet/core-docs/assignees{/user}","branches_url":"https://api.github.com/repos/dotnet/core-docs/branches{/branch}","tags_url":"https://api.github.com/repos/dotnet/core-docs/tags","blobs_url":"https://api.github.com/repos/dotnet/core-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dotnet/core-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dotnet/core-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/dotnet/core-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dotnet/core-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/dotnet/core-docs/languages","stargazers_url":"https://api.github.com/repos/dotnet/core-docs/stargazers","contributors_url":"https://api.github.com/repos/dotnet/core-docs/contributors","subscribers_url":"https://api.github.com/repos/dotnet/core-docs/subscribers","subscription_url":"https://api.github.com/repos/dotnet/core-docs/subscription","commits_url":"https://api.github.com/repos/dotnet/core-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/dotnet/core-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/dotnet/core-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/dotnet/core-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/dotnet/core-docs/contents/{+path}","compare_url":"https://api.github.com/repos/dotnet/core-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dotnet/core-docs/merges","archive_url":"https://api.github.com/repos/dotnet/core-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dotnet/core-docs/downloads","issues_url":"https://api.github.com/repos/dotnet/core-docs/issues{/number}","pulls_url":"https://api.github.com/repos/dotnet/core-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/dotnet/core-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/dotnet/core-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dotnet/core-docs/labels{/name}","releases_url":"https://api.github.com/repos/dotnet/core-docs/releases{/id}","created_at":"2015-05-19T15:13:32Z","updated_at":"2015-06-25T05:18:03Z","pushed_at":"2015-06-30T13:57:56Z","git_url":"git://github.com/dotnet/core-docs.git","ssh_url":"git@github.com:dotnet/core-docs.git","clone_url":"https://github.com/dotnet/core-docs.git","svn_url":"https://github.com/dotnet/core-docs","homepage":"http://dotnet.readthedocs.org","size":1233,"stargazers_count":4,"watchers_count":4,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":5,"mirror_url":null,"open_issues_count":2,"forks":5,"open_issues":2,"watchers":4,"default_branch":"master"}},"base":{"label":"dotnet:master","ref":"master","sha":"72cd94c19ffe0d9faea29c38a612b1d1a05b366b","user":{"login":"dotnet","id":9141961,"avatar_url":"https://avatars.githubusercontent.com/u/9141961?v=3","gravatar_id":"","url":"https://api.github.com/users/dotnet","html_url":"https://github.com/dotnet","followers_url":"https://api.github.com/users/dotnet/followers","following_url":"https://api.github.com/users/dotnet/following{/other_user}","gists_url":"https://api.github.com/users/dotnet/gists{/gist_id}","starred_url":"https://api.github.com/users/dotnet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dotnet/subscriptions","organizations_url":"https://api.github.com/users/dotnet/orgs","repos_url":"https://api.github.com/users/dotnet/repos","events_url":"https://api.github.com/users/dotnet/events{/privacy}","received_events_url":"https://api.github.com/users/dotnet/received_events","type":"Organization","site_admin":false},"repo":{"id":35890081,"name":"core-docs","full_name":"dotnet/core-docs","owner":{"login":"dotnet","id":9141961,"avatar_url":"https://avatars.githubusercontent.com/u/9141961?v=3","gravatar_id":"","url":"https://api.github.com/users/dotnet","html_url":"https://github.com/dotnet","followers_url":"https://api.github.com/users/dotnet/followers","following_url":"https://api.github.com/users/dotnet/following{/other_user}","gists_url":"https://api.github.com/users/dotnet/gists{/gist_id}","starred_url":"https://api.github.com/users/dotnet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dotnet/subscriptions","organizations_url":"https://api.github.com/users/dotnet/orgs","repos_url":"https://api.github.com/users/dotnet/repos","events_url":"https://api.github.com/users/dotnet/events{/privacy}","received_events_url":"https://api.github.com/users/dotnet/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/dotnet/core-docs","description":".NET Core documentation (work in progress).","fork":false,"url":"https://api.github.com/repos/dotnet/core-docs","forks_url":"https://api.github.com/repos/dotnet/core-docs/forks","keys_url":"https://api.github.com/repos/dotnet/core-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dotnet/core-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dotnet/core-docs/teams","hooks_url":"https://api.github.com/repos/dotnet/core-docs/hooks","issue_events_url":"https://api.github.com/repos/dotnet/core-docs/issues/events{/number}","events_url":"https://api.github.com/repos/dotnet/core-docs/events","assignees_url":"https://api.github.com/repos/dotnet/core-docs/assignees{/user}","branches_url":"https://api.github.com/repos/dotnet/core-docs/branches{/branch}","tags_url":"https://api.github.com/repos/dotnet/core-docs/tags","blobs_url":"https://api.github.com/repos/dotnet/core-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dotnet/core-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dotnet/core-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/dotnet/core-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dotnet/core-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/dotnet/core-docs/languages","stargazers_url":"https://api.github.com/repos/dotnet/core-docs/stargazers","contributors_url":"https://api.github.com/repos/dotnet/core-docs/contributors","subscribers_url":"https://api.github.com/repos/dotnet/core-docs/subscribers","subscription_url":"https://api.github.com/repos/dotnet/core-docs/subscription","commits_url":"https://api.github.com/repos/dotnet/core-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/dotnet/core-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/dotnet/core-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/dotnet/core-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/dotnet/core-docs/contents/{+path}","compare_url":"https://api.github.com/repos/dotnet/core-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dotnet/core-docs/merges","archive_url":"https://api.github.com/repos/dotnet/core-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dotnet/core-docs/downloads","issues_url":"https://api.github.com/repos/dotnet/core-docs/issues{/number}","pulls_url":"https://api.github.com/repos/dotnet/core-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/dotnet/core-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/dotnet/core-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dotnet/core-docs/labels{/name}","releases_url":"https://api.github.com/repos/dotnet/core-docs/releases{/id}","created_at":"2015-05-19T15:13:32Z","updated_at":"2015-06-25T05:18:03Z","pushed_at":"2015-06-30T13:57:56Z","git_url":"git://github.com/dotnet/core-docs.git","ssh_url":"git@github.com:dotnet/core-docs.git","clone_url":"https://github.com/dotnet/core-docs.git","svn_url":"https://github.com/dotnet/core-docs","homepage":"http://dotnet.readthedocs.org","size":1233,"stargazers_count":4,"watchers_count":4,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":5,"mirror_url":null,"open_issues_count":2,"forks":5,"open_issues":2,"watchers":4,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/dotnet/core-docs/pulls/20"},"html":{"href":"https://github.com/dotnet/core-docs/pull/20"},"issue":{"href":"https://api.github.com/repos/dotnet/core-docs/issues/20"},"comments":{"href":"https://api.github.com/repos/dotnet/core-docs/issues/20/comments"},"review_comments":{"href":"https://api.github.com/repos/dotnet/core-docs/pulls/20/comments"},"review_comment":{"href":"https://api.github.com/repos/dotnet/core-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/dotnet/core-docs/pulls/20/commits"},"statuses":{"href":"https://api.github.com/repos/dotnet/core-docs/statuses/f3786b9c554b6d84a88382cf7deea3294a92e61a"}}}}