{"action":"created","comment":{"url":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/comments/54697803","id":54697803,"diff_hunk":"@@ -9,15 +9,37 @@ When creating a pull request:\n   example: ``feature/what-my-pr-does``. Note that dashes should be used\n   instead of spaces (not underscores).\n * Add your feature/bugfix/enhancement.\n+* Do atomic and logically separate commits (use the power of ``git rebase`` to\n+  have a clean and logical history).\n+* Write good commit messages (see the tip below).\n * Write tests.\n * :doc:`test-your-code`.\n * Add a line in the format of \"<type> <pr-number>\n   [<affected bundle or component>] <description>\" to the ``CHANGELOG.md`` file\n   in the root directory.\n-* In case you have some changes breaking backwards compability you also have to\n+* In case you have some changes breaking backwards compatibility you also have to\n   add a description to the ``UPGRADE.md`` file in the root directory.\n-* Use a meaningful name for the pull request.\n+* Use a meaningful name for the pull request (see the tip below).\n * Create the pull request as soon as possible.\n+* In addition to this \"code\" pull request, you must also send a pull request to\n+  the `documentation repository`_ to update the documentation when appropriate.\n+\n+.. tip::\n+\n+    A good commit message is composed of a summary (the first line),\n+    optionally followed by a blank line and a more detailed description. The\n+    summary should start with the Component you are working on in square\n+    brackets (``[MediaBundle]``, ``[ContentBundle]``, ...). Use a\n+    verb (``fixed ...``, ``added ...``, ...) to start the summary and don't\n+    add a period at the end.\n+\n+.. tip::\n+\n+    A good pull request title should start with the Component you are working on\n+    in square brackets (``[MediaBundle]``, ``[ContentBundle]``, ...). Use a\n+    verb (``fixed ...``, ``added ...``, ...) to start the title and don't","path":"developer/contributing/pull-requests.rst","position":34,"original_position":34,"commit_id":"b0e1d1c3aa39e85c0129e6ace986374516e65022","original_commit_id":"b0e1d1c3aa39e85c0129e6ace986374516e65022","user":{"login":"webmozart","id":176399,"avatar_url":"https://avatars.githubusercontent.com/u/176399?v=3","gravatar_id":"","url":"https://api.github.com/users/webmozart","html_url":"https://github.com/webmozart","followers_url":"https://api.github.com/users/webmozart/followers","following_url":"https://api.github.com/users/webmozart/following{/other_user}","gists_url":"https://api.github.com/users/webmozart/gists{/gist_id}","starred_url":"https://api.github.com/users/webmozart/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/webmozart/subscriptions","organizations_url":"https://api.github.com/users/webmozart/orgs","repos_url":"https://api.github.com/users/webmozart/repos","events_url":"https://api.github.com/users/webmozart/events{/privacy}","received_events_url":"https://api.github.com/users/webmozart/received_events","type":"User","site_admin":false},"body":"as above","created_at":"2016-03-02T09:24:00Z","updated_at":"2016-03-02T09:24:00Z","html_url":"https://github.com/sulu-io/sulu-docs/pull/180#discussion_r54697803","pull_request_url":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/180","_links":{"self":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/comments/54697803"},"html":{"href":"https://github.com/sulu-io/sulu-docs/pull/180#discussion_r54697803"},"pull_request":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/180"}}},"pull_request":{"url":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/180","id":61333440,"html_url":"https://github.com/sulu-io/sulu-docs/pull/180","diff_url":"https://github.com/sulu-io/sulu-docs/pull/180.diff","patch_url":"https://github.com/sulu-io/sulu-docs/pull/180.patch","issue_url":"https://api.github.com/repos/sulu-io/sulu-docs/issues/180","number":180,"state":"open","locked":false,"title":"[Contributing] Enhance the pull request docs to higher quality","user":{"login":"patkar","id":993350,"avatar_url":"https://avatars.githubusercontent.com/u/993350?v=3","gravatar_id":"","url":"https://api.github.com/users/patkar","html_url":"https://github.com/patkar","followers_url":"https://api.github.com/users/patkar/followers","following_url":"https://api.github.com/users/patkar/following{/other_user}","gists_url":"https://api.github.com/users/patkar/gists{/gist_id}","starred_url":"https://api.github.com/users/patkar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/patkar/subscriptions","organizations_url":"https://api.github.com/users/patkar/orgs","repos_url":"https://api.github.com/users/patkar/repos","events_url":"https://api.github.com/users/patkar/events{/privacy}","received_events_url":"https://api.github.com/users/patkar/received_events","type":"User","site_admin":false},"body":"| Q | A\r\n| --- | ---\r\n| Fixed tickets | sulu-io/sulu#2073\r\n| License | MIT\r\n\r\n#### Description\r\n\r\nIt goes one in one with the new pull request template in the sulu repo, but it also says clearer that you should rebasing and thus create atomic and logically separate commits. Additionally it says to prefix commits and pull requests already with the affected component for better bisecting and searching on GitHub.\r\n\r\nMost of the changes are inspired by the Symfony contributing docs.\r\n\r\n#### Purpose\r\n\r\nTo have high quality pull requests it is not enough to create a pull request template. It must be described in details and especially the checklist needs exlanations","created_at":"2016-03-02T00:34:55Z","updated_at":"2016-03-02T09:24:00Z","closed_at":null,"merged_at":null,"merge_commit_sha":"6d19aa76d4706f6486b87faec95b514e9f7c31c9","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/180/commits","review_comments_url":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/180/comments","review_comment_url":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/sulu-io/sulu-docs/issues/180/comments","statuses_url":"https://api.github.com/repos/sulu-io/sulu-docs/statuses/b0e1d1c3aa39e85c0129e6ace986374516e65022","head":{"label":"Karisch:enhancement/contributing","ref":"enhancement/contributing","sha":"b0e1d1c3aa39e85c0129e6ace986374516e65022","user":{"login":"Karisch","id":9296888,"avatar_url":"https://avatars.githubusercontent.com/u/9296888?v=3","gravatar_id":"","url":"https://api.github.com/users/Karisch","html_url":"https://github.com/Karisch","followers_url":"https://api.github.com/users/Karisch/followers","following_url":"https://api.github.com/users/Karisch/following{/other_user}","gists_url":"https://api.github.com/users/Karisch/gists{/gist_id}","starred_url":"https://api.github.com/users/Karisch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Karisch/subscriptions","organizations_url":"https://api.github.com/users/Karisch/orgs","repos_url":"https://api.github.com/users/Karisch/repos","events_url":"https://api.github.com/users/Karisch/events{/privacy}","received_events_url":"https://api.github.com/users/Karisch/received_events","type":"Organization","site_admin":false},"repo":{"id":51603431,"name":"sulu-docs","full_name":"Karisch/sulu-docs","owner":{"login":"Karisch","id":9296888,"avatar_url":"https://avatars.githubusercontent.com/u/9296888?v=3","gravatar_id":"","url":"https://api.github.com/users/Karisch","html_url":"https://github.com/Karisch","followers_url":"https://api.github.com/users/Karisch/followers","following_url":"https://api.github.com/users/Karisch/following{/other_user}","gists_url":"https://api.github.com/users/Karisch/gists{/gist_id}","starred_url":"https://api.github.com/users/Karisch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Karisch/subscriptions","organizations_url":"https://api.github.com/users/Karisch/orgs","repos_url":"https://api.github.com/users/Karisch/repos","events_url":"https://api.github.com/users/Karisch/events{/privacy}","received_events_url":"https://api.github.com/users/Karisch/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Karisch/sulu-docs","description":"Sulu documentation","fork":true,"url":"https://api.github.com/repos/Karisch/sulu-docs","forks_url":"https://api.github.com/repos/Karisch/sulu-docs/forks","keys_url":"https://api.github.com/repos/Karisch/sulu-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Karisch/sulu-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Karisch/sulu-docs/teams","hooks_url":"https://api.github.com/repos/Karisch/sulu-docs/hooks","issue_events_url":"https://api.github.com/repos/Karisch/sulu-docs/issues/events{/number}","events_url":"https://api.github.com/repos/Karisch/sulu-docs/events","assignees_url":"https://api.github.com/repos/Karisch/sulu-docs/assignees{/user}","branches_url":"https://api.github.com/repos/Karisch/sulu-docs/branches{/branch}","tags_url":"https://api.github.com/repos/Karisch/sulu-docs/tags","blobs_url":"https://api.github.com/repos/Karisch/sulu-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Karisch/sulu-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Karisch/sulu-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/Karisch/sulu-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Karisch/sulu-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/Karisch/sulu-docs/languages","stargazers_url":"https://api.github.com/repos/Karisch/sulu-docs/stargazers","contributors_url":"https://api.github.com/repos/Karisch/sulu-docs/contributors","subscribers_url":"https://api.github.com/repos/Karisch/sulu-docs/subscribers","subscription_url":"https://api.github.com/repos/Karisch/sulu-docs/subscription","commits_url":"https://api.github.com/repos/Karisch/sulu-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/Karisch/sulu-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/Karisch/sulu-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/Karisch/sulu-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/Karisch/sulu-docs/contents/{+path}","compare_url":"https://api.github.com/repos/Karisch/sulu-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Karisch/sulu-docs/merges","archive_url":"https://api.github.com/repos/Karisch/sulu-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Karisch/sulu-docs/downloads","issues_url":"https://api.github.com/repos/Karisch/sulu-docs/issues{/number}","pulls_url":"https://api.github.com/repos/Karisch/sulu-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/Karisch/sulu-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/Karisch/sulu-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Karisch/sulu-docs/labels{/name}","releases_url":"https://api.github.com/repos/Karisch/sulu-docs/releases{/id}","deployments_url":"https://api.github.com/repos/Karisch/sulu-docs/deployments","created_at":"2016-02-12T17:10:48Z","updated_at":"2016-02-12T17:10:49Z","pushed_at":"2016-03-02T01:04:05Z","git_url":"git://github.com/Karisch/sulu-docs.git","ssh_url":"git@github.com:Karisch/sulu-docs.git","clone_url":"https://github.com/Karisch/sulu-docs.git","svn_url":"https://github.com/Karisch/sulu-docs","homepage":"docs.sulu.io","size":2449,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"develop"}},"base":{"label":"sulu-io:master","ref":"master","sha":"f2a1aa46889350b71955d5d6fc5683fe8394c0a9","user":{"login":"sulu-io","id":5717006,"avatar_url":"https://avatars.githubusercontent.com/u/5717006?v=3","gravatar_id":"","url":"https://api.github.com/users/sulu-io","html_url":"https://github.com/sulu-io","followers_url":"https://api.github.com/users/sulu-io/followers","following_url":"https://api.github.com/users/sulu-io/following{/other_user}","gists_url":"https://api.github.com/users/sulu-io/gists{/gist_id}","starred_url":"https://api.github.com/users/sulu-io/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sulu-io/subscriptions","organizations_url":"https://api.github.com/users/sulu-io/orgs","repos_url":"https://api.github.com/users/sulu-io/repos","events_url":"https://api.github.com/users/sulu-io/events{/privacy}","received_events_url":"https://api.github.com/users/sulu-io/received_events","type":"Organization","site_admin":false},"repo":{"id":22838344,"name":"sulu-docs","full_name":"sulu-io/sulu-docs","owner":{"login":"sulu-io","id":5717006,"avatar_url":"https://avatars.githubusercontent.com/u/5717006?v=3","gravatar_id":"","url":"https://api.github.com/users/sulu-io","html_url":"https://github.com/sulu-io","followers_url":"https://api.github.com/users/sulu-io/followers","following_url":"https://api.github.com/users/sulu-io/following{/other_user}","gists_url":"https://api.github.com/users/sulu-io/gists{/gist_id}","starred_url":"https://api.github.com/users/sulu-io/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sulu-io/subscriptions","organizations_url":"https://api.github.com/users/sulu-io/orgs","repos_url":"https://api.github.com/users/sulu-io/repos","events_url":"https://api.github.com/users/sulu-io/events{/privacy}","received_events_url":"https://api.github.com/users/sulu-io/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sulu-io/sulu-docs","description":"Sulu documentation","fork":false,"url":"https://api.github.com/repos/sulu-io/sulu-docs","forks_url":"https://api.github.com/repos/sulu-io/sulu-docs/forks","keys_url":"https://api.github.com/repos/sulu-io/sulu-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sulu-io/sulu-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sulu-io/sulu-docs/teams","hooks_url":"https://api.github.com/repos/sulu-io/sulu-docs/hooks","issue_events_url":"https://api.github.com/repos/sulu-io/sulu-docs/issues/events{/number}","events_url":"https://api.github.com/repos/sulu-io/sulu-docs/events","assignees_url":"https://api.github.com/repos/sulu-io/sulu-docs/assignees{/user}","branches_url":"https://api.github.com/repos/sulu-io/sulu-docs/branches{/branch}","tags_url":"https://api.github.com/repos/sulu-io/sulu-docs/tags","blobs_url":"https://api.github.com/repos/sulu-io/sulu-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sulu-io/sulu-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sulu-io/sulu-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/sulu-io/sulu-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sulu-io/sulu-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/sulu-io/sulu-docs/languages","stargazers_url":"https://api.github.com/repos/sulu-io/sulu-docs/stargazers","contributors_url":"https://api.github.com/repos/sulu-io/sulu-docs/contributors","subscribers_url":"https://api.github.com/repos/sulu-io/sulu-docs/subscribers","subscription_url":"https://api.github.com/repos/sulu-io/sulu-docs/subscription","commits_url":"https://api.github.com/repos/sulu-io/sulu-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/sulu-io/sulu-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/sulu-io/sulu-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/sulu-io/sulu-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/sulu-io/sulu-docs/contents/{+path}","compare_url":"https://api.github.com/repos/sulu-io/sulu-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sulu-io/sulu-docs/merges","archive_url":"https://api.github.com/repos/sulu-io/sulu-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sulu-io/sulu-docs/downloads","issues_url":"https://api.github.com/repos/sulu-io/sulu-docs/issues{/number}","pulls_url":"https://api.github.com/repos/sulu-io/sulu-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/sulu-io/sulu-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/sulu-io/sulu-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sulu-io/sulu-docs/labels{/name}","releases_url":"https://api.github.com/repos/sulu-io/sulu-docs/releases{/id}","deployments_url":"https://api.github.com/repos/sulu-io/sulu-docs/deployments","created_at":"2014-08-11T12:31:16Z","updated_at":"2016-01-11T13:21:53Z","pushed_at":"2016-03-02T01:06:08Z","git_url":"git://github.com/sulu-io/sulu-docs.git","ssh_url":"git@github.com:sulu-io/sulu-docs.git","clone_url":"https://github.com/sulu-io/sulu-docs.git","svn_url":"https://github.com/sulu-io/sulu-docs","homepage":"docs.sulu.io","size":2511,"stargazers_count":2,"watchers_count":2,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":17,"mirror_url":null,"open_issues_count":38,"forks":17,"open_issues":38,"watchers":2,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/180"},"html":{"href":"https://github.com/sulu-io/sulu-docs/pull/180"},"issue":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/issues/180"},"comments":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/issues/180/comments"},"review_comments":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/180/comments"},"review_comment":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/pulls/180/commits"},"statuses":{"href":"https://api.github.com/repos/sulu-io/sulu-docs/statuses/b0e1d1c3aa39e85c0129e6ace986374516e65022"}}}}