{"action":"created","comment":{"url":"https://api.github.com/repos/ARMmbed/Handbook/pulls/comments/177694179","pull_request_review_id":107609457,"id":177694179,"diff_hunk":"@@ -79,6 +79,43 @@ Each feature has a tech lead. This person is responsible for:\n - Rebasing often to track master development.\n - Reviewing any addition to the feature branch (approval required by the feature tech lead or another assigned person).\n \n+##### Pull request types\n+\n+We consider the following pull request types.\n+\n+##### Fix\n+\n+A bug fix should be backward-compatible internal change that fixes incorrect behavior. The fix should provide a description what and how it fixes the issue. The test should be included to catch this issue in the future and confirm the correct behavior.\n+\n+Release: patch version\n+\n+##### Refactor\n+\n+Refactors are intended for minor versions if they are not fixing specific issue as they \n+can introduce new issues.\n+\n+Release: minor version\n+\n+##### New target\n+\n+Adding a new target targets the patch release as it updating targets folder implementation.\n+\n+Release: patch version\n+\n+##### Feature\n+\n+New features targets minor releases. It can be integrated only if the feature supports most of the targets (if it requires new target HAL implementation).\n+\n+Adding a new functionality is considered to be a feature. It does not matter if it is C++ or C.\n+\n+Release: minor version\n+\n+##### Breaking change\n+\n+Any change that results in breaking user space. It should have strong justification to be considered. Often the change could be made backward compatible, for example deprecate the old functionality and introduce the new replacement.\n+\n+Release: minor version","path":"docs/reference/contributing/guidelines/workflow.md","position":39,"original_position":39,"commit_id":"18844a03b647e70100b400ec29ed86bd3be4244d","original_commit_id":"18844a03b647e70100b400ec29ed86bd3be4244d","user":{"login":"0xc0170","id":2963726,"avatar_url":"https://avatars0.githubusercontent.com/u/2963726?v=4","gravatar_id":"","url":"https://api.github.com/users/0xc0170","html_url":"https://github.com/0xc0170","followers_url":"https://api.github.com/users/0xc0170/followers","following_url":"https://api.github.com/users/0xc0170/following{/other_user}","gists_url":"https://api.github.com/users/0xc0170/gists{/gist_id}","starred_url":"https://api.github.com/users/0xc0170/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/0xc0170/subscriptions","organizations_url":"https://api.github.com/users/0xc0170/orgs","repos_url":"https://api.github.com/users/0xc0170/repos","events_url":"https://api.github.com/users/0xc0170/events{/privacy}","received_events_url":"https://api.github.com/users/0xc0170/received_events","type":"User","site_admin":false},"body":"> But we don't make breaking changes on minor releases.\r\n\r\nYes, this should not be seen often and thus should really provide strong reason to be considered. there are usually ways to do it backward compatible, but might not always be the case.\r\n\r\n> It is just a classification. If someone rewrites an algorithm which totally changes the behaviour of the system, then that is a breaking change but not a new feature....\r\n\r\nProposals for better specification of a breaking change ? It can be fix, feature or refactor if it results in breaking a user space. we can provide better examples here?","created_at":"2018-03-28T09:44:22Z","updated_at":"2018-03-28T09:44:23Z","html_url":"https://github.com/ARMmbed/Handbook/pull/475#discussion_r177694179","pull_request_url":"https://api.github.com/repos/ARMmbed/Handbook/pulls/475","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/ARMmbed/Handbook/pulls/comments/177694179"},"html":{"href":"https://github.com/ARMmbed/Handbook/pull/475#discussion_r177694179"},"pull_request":{"href":"https://api.github.com/repos/ARMmbed/Handbook/pulls/475"}},"in_reply_to_id":177689868},"pull_request":{"url":"https://api.github.com/repos/ARMmbed/Handbook/pulls/475","id":177978105,"html_url":"https://github.com/ARMmbed/Handbook/pull/475","diff_url":"https://github.com/ARMmbed/Handbook/pull/475.diff","patch_url":"https://github.com/ARMmbed/Handbook/pull/475.patch","issue_url":"https://api.github.com/repos/ARMmbed/Handbook/issues/475","number":475,"state":"open","locked":false,"title":"workflow: add PR types explanation","user":{"login":"0xc0170","id":2963726,"avatar_url":"https://avatars0.githubusercontent.com/u/2963726?v=4","gravatar_id":"","url":"https://api.github.com/users/0xc0170","html_url":"https://github.com/0xc0170","followers_url":"https://api.github.com/users/0xc0170/followers","following_url":"https://api.github.com/users/0xc0170/following{/other_user}","gists_url":"https://api.github.com/users/0xc0170/gists{/gist_id}","starred_url":"https://api.github.com/users/0xc0170/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/0xc0170/subscriptions","organizations_url":"https://api.github.com/users/0xc0170/orgs","repos_url":"https://api.github.com/users/0xc0170/repos","events_url":"https://api.github.com/users/0xc0170/events{/privacy}","received_events_url":"https://api.github.com/users/0xc0170/received_events","type":"User","site_admin":false},"body":"Every PR type should be clear to a user.\r\nIt is a user responsibility to specify PR type and accept the versioning based on it.\r\n\r\nFixes #429\r\n\r\nProposal to define PR types. I would like to reference this in every pull request so all of us are aware of the responsibility to select the proper type and the release label selection based on that.\r\n\r\nNeeds more work to be more clear and specify more details, expecting lot of comments 🔥 \r\n\r\n@sg- @cmonr @adbridge @theotherjimmy @kjbracey-arm Please review","created_at":"2018-03-28T09:26:00Z","updated_at":"2018-03-28T09:44:23Z","closed_at":null,"merged_at":null,"merge_commit_sha":"bfcc81a28b6d2cb851bd30593b5ff95a6c1d0169","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/ARMmbed/Handbook/pulls/475/commits","review_comments_url":"https://api.github.com/repos/ARMmbed/Handbook/pulls/475/comments","review_comment_url":"https://api.github.com/repos/ARMmbed/Handbook/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ARMmbed/Handbook/issues/475/comments","statuses_url":"https://api.github.com/repos/ARMmbed/Handbook/statuses/18844a03b647e70100b400ec29ed86bd3be4244d","head":{"label":"0xc0170:dev_pr_types","ref":"dev_pr_types","sha":"18844a03b647e70100b400ec29ed86bd3be4244d","user":{"login":"0xc0170","id":2963726,"avatar_url":"https://avatars0.githubusercontent.com/u/2963726?v=4","gravatar_id":"","url":"https://api.github.com/users/0xc0170","html_url":"https://github.com/0xc0170","followers_url":"https://api.github.com/users/0xc0170/followers","following_url":"https://api.github.com/users/0xc0170/following{/other_user}","gists_url":"https://api.github.com/users/0xc0170/gists{/gist_id}","starred_url":"https://api.github.com/users/0xc0170/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/0xc0170/subscriptions","organizations_url":"https://api.github.com/users/0xc0170/orgs","repos_url":"https://api.github.com/users/0xc0170/repos","events_url":"https://api.github.com/users/0xc0170/events{/privacy}","received_events_url":"https://api.github.com/users/0xc0170/received_events","type":"User","site_admin":false},"repo":{"id":85845710,"name":"Handbook","full_name":"0xc0170/Handbook","owner":{"login":"0xc0170","id":2963726,"avatar_url":"https://avatars0.githubusercontent.com/u/2963726?v=4","gravatar_id":"","url":"https://api.github.com/users/0xc0170","html_url":"https://github.com/0xc0170","followers_url":"https://api.github.com/users/0xc0170/followers","following_url":"https://api.github.com/users/0xc0170/following{/other_user}","gists_url":"https://api.github.com/users/0xc0170/gists{/gist_id}","starred_url":"https://api.github.com/users/0xc0170/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/0xc0170/subscriptions","organizations_url":"https://api.github.com/users/0xc0170/orgs","repos_url":"https://api.github.com/users/0xc0170/repos","events_url":"https://api.github.com/users/0xc0170/events{/privacy}","received_events_url":"https://api.github.com/users/0xc0170/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/0xc0170/Handbook","description":"New version of the handbook","fork":true,"url":"https://api.github.com/repos/0xc0170/Handbook","forks_url":"https://api.github.com/repos/0xc0170/Handbook/forks","keys_url":"https://api.github.com/repos/0xc0170/Handbook/keys{/key_id}","collaborators_url":"https://api.github.com/repos/0xc0170/Handbook/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/0xc0170/Handbook/teams","hooks_url":"https://api.github.com/repos/0xc0170/Handbook/hooks","issue_events_url":"https://api.github.com/repos/0xc0170/Handbook/issues/events{/number}","events_url":"https://api.github.com/repos/0xc0170/Handbook/events","assignees_url":"https://api.github.com/repos/0xc0170/Handbook/assignees{/user}","branches_url":"https://api.github.com/repos/0xc0170/Handbook/branches{/branch}","tags_url":"https://api.github.com/repos/0xc0170/Handbook/tags","blobs_url":"https://api.github.com/repos/0xc0170/Handbook/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/0xc0170/Handbook/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/0xc0170/Handbook/git/refs{/sha}","trees_url":"https://api.github.com/repos/0xc0170/Handbook/git/trees{/sha}","statuses_url":"https://api.github.com/repos/0xc0170/Handbook/statuses/{sha}","languages_url":"https://api.github.com/repos/0xc0170/Handbook/languages","stargazers_url":"https://api.github.com/repos/0xc0170/Handbook/stargazers","contributors_url":"https://api.github.com/repos/0xc0170/Handbook/contributors","subscribers_url":"https://api.github.com/repos/0xc0170/Handbook/subscribers","subscription_url":"https://api.github.com/repos/0xc0170/Handbook/subscription","commits_url":"https://api.github.com/repos/0xc0170/Handbook/commits{/sha}","git_commits_url":"https://api.github.com/repos/0xc0170/Handbook/git/commits{/sha}","comments_url":"https://api.github.com/repos/0xc0170/Handbook/comments{/number}","issue_comment_url":"https://api.github.com/repos/0xc0170/Handbook/issues/comments{/number}","contents_url":"https://api.github.com/repos/0xc0170/Handbook/contents/{+path}","compare_url":"https://api.github.com/repos/0xc0170/Handbook/compare/{base}...{head}","merges_url":"https://api.github.com/repos/0xc0170/Handbook/merges","archive_url":"https://api.github.com/repos/0xc0170/Handbook/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/0xc0170/Handbook/downloads","issues_url":"https://api.github.com/repos/0xc0170/Handbook/issues{/number}","pulls_url":"https://api.github.com/repos/0xc0170/Handbook/pulls{/number}","milestones_url":"https://api.github.com/repos/0xc0170/Handbook/milestones{/number}","notifications_url":"https://api.github.com/repos/0xc0170/Handbook/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/0xc0170/Handbook/labels{/name}","releases_url":"https://api.github.com/repos/0xc0170/Handbook/releases{/id}","deployments_url":"https://api.github.com/repos/0xc0170/Handbook/deployments","created_at":"2017-03-22T15:37:47Z","updated_at":"2017-02-06T05:43:15Z","pushed_at":"2018-03-28T09:23:32Z","git_url":"git://github.com/0xc0170/Handbook.git","ssh_url":"git@github.com:0xc0170/Handbook.git","clone_url":"https://github.com/0xc0170/Handbook.git","svn_url":"https://github.com/0xc0170/Handbook","homepage":null,"size":25730,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":null,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"ARMmbed:new_engine","ref":"new_engine","sha":"5df843491ea77f9ace4c086868f885ca4fca8691","user":{"login":"ARMmbed","id":8916057,"avatar_url":"https://avatars3.githubusercontent.com/u/8916057?v=4","gravatar_id":"","url":"https://api.github.com/users/ARMmbed","html_url":"https://github.com/ARMmbed","followers_url":"https://api.github.com/users/ARMmbed/followers","following_url":"https://api.github.com/users/ARMmbed/following{/other_user}","gists_url":"https://api.github.com/users/ARMmbed/gists{/gist_id}","starred_url":"https://api.github.com/users/ARMmbed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ARMmbed/subscriptions","organizations_url":"https://api.github.com/users/ARMmbed/orgs","repos_url":"https://api.github.com/users/ARMmbed/repos","events_url":"https://api.github.com/users/ARMmbed/events{/privacy}","received_events_url":"https://api.github.com/users/ARMmbed/received_events","type":"Organization","site_admin":false},"repo":{"id":31957877,"name":"Handbook","full_name":"ARMmbed/Handbook","owner":{"login":"ARMmbed","id":8916057,"avatar_url":"https://avatars3.githubusercontent.com/u/8916057?v=4","gravatar_id":"","url":"https://api.github.com/users/ARMmbed","html_url":"https://github.com/ARMmbed","followers_url":"https://api.github.com/users/ARMmbed/followers","following_url":"https://api.github.com/users/ARMmbed/following{/other_user}","gists_url":"https://api.github.com/users/ARMmbed/gists{/gist_id}","starred_url":"https://api.github.com/users/ARMmbed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ARMmbed/subscriptions","organizations_url":"https://api.github.com/users/ARMmbed/orgs","repos_url":"https://api.github.com/users/ARMmbed/repos","events_url":"https://api.github.com/users/ARMmbed/events{/privacy}","received_events_url":"https://api.github.com/users/ARMmbed/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ARMmbed/Handbook","description":"New version of the handbook for Mbed OS","fork":false,"url":"https://api.github.com/repos/ARMmbed/Handbook","forks_url":"https://api.github.com/repos/ARMmbed/Handbook/forks","keys_url":"https://api.github.com/repos/ARMmbed/Handbook/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ARMmbed/Handbook/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ARMmbed/Handbook/teams","hooks_url":"https://api.github.com/repos/ARMmbed/Handbook/hooks","issue_events_url":"https://api.github.com/repos/ARMmbed/Handbook/issues/events{/number}","events_url":"https://api.github.com/repos/ARMmbed/Handbook/events","assignees_url":"https://api.github.com/repos/ARMmbed/Handbook/assignees{/user}","branches_url":"https://api.github.com/repos/ARMmbed/Handbook/branches{/branch}","tags_url":"https://api.github.com/repos/ARMmbed/Handbook/tags","blobs_url":"https://api.github.com/repos/ARMmbed/Handbook/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ARMmbed/Handbook/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ARMmbed/Handbook/git/refs{/sha}","trees_url":"https://api.github.com/repos/ARMmbed/Handbook/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ARMmbed/Handbook/statuses/{sha}","languages_url":"https://api.github.com/repos/ARMmbed/Handbook/languages","stargazers_url":"https://api.github.com/repos/ARMmbed/Handbook/stargazers","contributors_url":"https://api.github.com/repos/ARMmbed/Handbook/contributors","subscribers_url":"https://api.github.com/repos/ARMmbed/Handbook/subscribers","subscription_url":"https://api.github.com/repos/ARMmbed/Handbook/subscription","commits_url":"https://api.github.com/repos/ARMmbed/Handbook/commits{/sha}","git_commits_url":"https://api.github.com/repos/ARMmbed/Handbook/git/commits{/sha}","comments_url":"https://api.github.com/repos/ARMmbed/Handbook/comments{/number}","issue_comment_url":"https://api.github.com/repos/ARMmbed/Handbook/issues/comments{/number}","contents_url":"https://api.github.com/repos/ARMmbed/Handbook/contents/{+path}","compare_url":"https://api.github.com/repos/ARMmbed/Handbook/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ARMmbed/Handbook/merges","archive_url":"https://api.github.com/repos/ARMmbed/Handbook/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ARMmbed/Handbook/downloads","issues_url":"https://api.github.com/repos/ARMmbed/Handbook/issues{/number}","pulls_url":"https://api.github.com/repos/ARMmbed/Handbook/pulls{/number}","milestones_url":"https://api.github.com/repos/ARMmbed/Handbook/milestones{/number}","notifications_url":"https://api.github.com/repos/ARMmbed/Handbook/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ARMmbed/Handbook/labels{/name}","releases_url":"https://api.github.com/repos/ARMmbed/Handbook/releases{/id}","deployments_url":"https://api.github.com/repos/ARMmbed/Handbook/deployments","created_at":"2015-03-10T13:06:41Z","updated_at":"2018-03-27T19:30:22Z","pushed_at":"2018-03-28T09:26:01Z","git_url":"git://github.com/ARMmbed/Handbook.git","ssh_url":"git@github.com:ARMmbed/Handbook.git","clone_url":"https://github.com/ARMmbed/Handbook.git","svn_url":"https://github.com/ARMmbed/Handbook","homepage":"","size":26155,"stargazers_count":26,"watchers_count":26,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":79,"mirror_url":null,"archived":false,"open_issues_count":33,"license":null,"forks":79,"open_issues":33,"watchers":26,"default_branch":"new_engine"}},"_links":{"self":{"href":"https://api.github.com/repos/ARMmbed/Handbook/pulls/475"},"html":{"href":"https://github.com/ARMmbed/Handbook/pull/475"},"issue":{"href":"https://api.github.com/repos/ARMmbed/Handbook/issues/475"},"comments":{"href":"https://api.github.com/repos/ARMmbed/Handbook/issues/475/comments"},"review_comments":{"href":"https://api.github.com/repos/ARMmbed/Handbook/pulls/475/comments"},"review_comment":{"href":"https://api.github.com/repos/ARMmbed/Handbook/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ARMmbed/Handbook/pulls/475/commits"},"statuses":{"href":"https://api.github.com/repos/ARMmbed/Handbook/statuses/18844a03b647e70100b400ec29ed86bd3be4244d"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"0xc0170"}}