{"action":"created","comment":{"url":"https://api.github.com/repos/opf/openproject/pulls/comments/25170798","id":25170798,"diff_hunk":"@@ -1,7 +1,46 @@\n-OpenProject is an open source project and we encourage you to help us out. We'd be happy if you do one of these things:\n+OpenProject is an open source project and we encourage you to help us out. For contributing to OpenProject, please do follow these steps:\n \n-* Create a [new work package on openproject.org](https://community.openproject.org/projects/openproject/work_packages) if you find a bug or need a feature\n-* Help out other people on our [forums](https://community.openproject.org/projects/openproject/boards)\n-* Help us [translate OpenProject to more languages](https://community.openproject.org/projects/openproject/wiki/Translations)\n-* Contribute code via GitHub Pull Requests, see our [contribution page](https://community.openproject.org/projects/openproject/wiki/Contribution) for more information\n-* See [Git Flow](https://community.openproject.org/projects/openproject/wiki/Git_Branching_Model)\n+## Development flow\n+For contributing source code, please follow the Git Workflow below:\n+\n+- Fork Openproject on GitHub\n+- Clone your fork to your development machine: \n+\n+```\n+git clone git@github.com/<username>/openproject\n+```\n+\n+- Optional: Add the original OpenProject repository as a remote, so you can fetch changes: \n+\n+```\n+git remote add upstream git@github.com:/opf/openproject\n+```\n+\n+- Make sure you're on the right branch. The main development branch is `dev`: \n+\n+```\n+git checkout dev\n+```\n+\n+- Create a feature branch: \n+\n+```\n+git checkout -b feature/<short description of your feature>\n+```\n+\n+- Make your changes, then push the branch into your ***own*** repository:\n+\n+```\n+git push origin <your feature branch>\n+```\n+\n+- Create a pull request (PR) against a branch of of the <opf/openproject> repository, containing a ***clear description*** of what the pull request attempts to change and/or fix. \n+\n+We will then review your PR. Please note that you can add commits after the PR has been created by pushing to the branch in your fork.\n+\n+## Important notices\n+\n+- Please add tests to your code to verify functionality, especially if it is a new feature. Please also run these tests locally.\n+- Please create pull requests against the current `dev` branch. Hotfixes and Bugfixes should be created against the appropiate `release/*` branch.","path":"CONTRIBUTING.md","position":50,"original_position":50,"commit_id":"fb56e927fbc1402547a48c127da41a8c00549356","original_commit_id":"1f69f4fc57534d209d6203f41019723687699dc2","user":{"login":"floriank","id":498241,"avatar_url":"https://avatars.githubusercontent.com/u/498241?v=3","gravatar_id":"","url":"https://api.github.com/users/floriank","html_url":"https://github.com/floriank","followers_url":"https://api.github.com/users/floriank/followers","following_url":"https://api.github.com/users/floriank/following{/other_user}","gists_url":"https://api.github.com/users/floriank/gists{/gist_id}","starred_url":"https://api.github.com/users/floriank/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/floriank/subscriptions","organizations_url":"https://api.github.com/users/floriank/orgs","repos_url":"https://api.github.com/users/floriank/repos","events_url":"https://api.github.com/users/floriank/events{/privacy}","received_events_url":"https://api.github.com/users/floriank/received_events","type":"User","site_admin":false},"body":"You have to help me out here. My understanding after a couple of weeks:\r\n\r\n1. Features/gem updates go against `dev`\r\n2. Hotfixes go against latest `release/*`\r\n3. Bugfixes go into `dev`\r\n4. Backports (bugfixes/hotfixes) go into `release/*`\r\n","created_at":"2015-02-23T15:15:10Z","updated_at":"2015-02-23T15:15:10Z","html_url":"https://github.com/opf/openproject/pull/2611#discussion_r25170798","pull_request_url":"https://api.github.com/repos/opf/openproject/pulls/2611","_links":{"self":{"href":"https://api.github.com/repos/opf/openproject/pulls/comments/25170798"},"html":{"href":"https://github.com/opf/openproject/pull/2611#discussion_r25170798"},"pull_request":{"href":"https://api.github.com/repos/opf/openproject/pulls/2611"}}},"pull_request":{"url":"https://api.github.com/repos/opf/openproject/pulls/2611","id":29797518,"html_url":"https://github.com/opf/openproject/pull/2611","diff_url":"https://github.com/opf/openproject/pull/2611.diff","patch_url":"https://github.com/opf/openproject/pull/2611.patch","issue_url":"https://api.github.com/repos/opf/openproject/issues/2611","number":2611,"state":"open","locked":false,"title":"Update the contributing guidelines","user":{"login":"floriank","id":498241,"avatar_url":"https://avatars.githubusercontent.com/u/498241?v=3","gravatar_id":"","url":"https://api.github.com/users/floriank","html_url":"https://github.com/floriank","followers_url":"https://api.github.com/users/floriank/followers","following_url":"https://api.github.com/users/floriank/following{/other_user}","gists_url":"https://api.github.com/users/floriank/gists{/gist_id}","starred_url":"https://api.github.com/users/floriank/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/floriank/subscriptions","organizations_url":"https://api.github.com/users/floriank/orgs","repos_url":"https://api.github.com/users/floriank/repos","events_url":"https://api.github.com/users/floriank/events{/privacy}","received_events_url":"https://api.github.com/users/floriank/received_events","type":"User","site_admin":false},"body":"## Goal\r\n\r\nIn the light of some of the latest pull requests it became apparent hat we lack a single source of truth when it comes to the guidelines for contributing to OpenProject.\r\n\r\nAfter some reviewing and looking into the history, I updated the guidelines for contributing to OpenProject to reflect current practices.\r\n\r\n## Notes\r\n\r\nInformation has been pulled together from different source, mainly the [Guidelines from the OpenProject](https://community.openproject.org/projects/openproject/wiki/Git_Workflow) wiki (which is no longer available to me), comments made by @linki in #1362 and the discussion in #2594, as well as discussion with @ulferts on current practices in handling PRs.\r\n\r\nThere also was a discussion with @myabc last week on using [CLAHub](https://www.clahub.com/) for contributors to the repository, to which these guidelines have no reflection of. I'd be happy on discussing this topic, as there is some need of that in my opinion.\r\n\r\n## Ticket\r\n\r\nhttps://community.openproject.org/work_packages/18827","created_at":"2015-02-23T10:16:05Z","updated_at":"2015-02-23T15:15:10Z","closed_at":null,"merged_at":null,"merge_commit_sha":"ddb9810b28e25d93b065cbaca68020c65b5ad876","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/opf/openproject/pulls/2611/commits","review_comments_url":"https://api.github.com/repos/opf/openproject/pulls/2611/comments","review_comment_url":"https://api.github.com/repos/opf/openproject/pulls/comments{/number}","comments_url":"https://api.github.com/repos/opf/openproject/issues/2611/comments","statuses_url":"https://api.github.com/repos/opf/openproject/statuses/fb56e927fbc1402547a48c127da41a8c00549356","head":{"label":"floriank:fix/update-contributing","ref":"fix/update-contributing","sha":"fb56e927fbc1402547a48c127da41a8c00549356","user":{"login":"floriank","id":498241,"avatar_url":"https://avatars.githubusercontent.com/u/498241?v=3","gravatar_id":"","url":"https://api.github.com/users/floriank","html_url":"https://github.com/floriank","followers_url":"https://api.github.com/users/floriank/followers","following_url":"https://api.github.com/users/floriank/following{/other_user}","gists_url":"https://api.github.com/users/floriank/gists{/gist_id}","starred_url":"https://api.github.com/users/floriank/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/floriank/subscriptions","organizations_url":"https://api.github.com/users/floriank/orgs","repos_url":"https://api.github.com/users/floriank/repos","events_url":"https://api.github.com/users/floriank/events{/privacy}","received_events_url":"https://api.github.com/users/floriank/received_events","type":"User","site_admin":false},"repo":{"id":29468662,"name":"openproject","full_name":"floriank/openproject","owner":{"login":"floriank","id":498241,"avatar_url":"https://avatars.githubusercontent.com/u/498241?v=3","gravatar_id":"","url":"https://api.github.com/users/floriank","html_url":"https://github.com/floriank","followers_url":"https://api.github.com/users/floriank/followers","following_url":"https://api.github.com/users/floriank/following{/other_user}","gists_url":"https://api.github.com/users/floriank/gists{/gist_id}","starred_url":"https://api.github.com/users/floriank/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/floriank/subscriptions","organizations_url":"https://api.github.com/users/floriank/orgs","repos_url":"https://api.github.com/users/floriank/repos","events_url":"https://api.github.com/users/floriank/events{/privacy}","received_events_url":"https://api.github.com/users/floriank/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/floriank/openproject","description":"OpenProject is a web based project management system built on Ruby on Rails","fork":true,"url":"https://api.github.com/repos/floriank/openproject","forks_url":"https://api.github.com/repos/floriank/openproject/forks","keys_url":"https://api.github.com/repos/floriank/openproject/keys{/key_id}","collaborators_url":"https://api.github.com/repos/floriank/openproject/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/floriank/openproject/teams","hooks_url":"https://api.github.com/repos/floriank/openproject/hooks","issue_events_url":"https://api.github.com/repos/floriank/openproject/issues/events{/number}","events_url":"https://api.github.com/repos/floriank/openproject/events","assignees_url":"https://api.github.com/repos/floriank/openproject/assignees{/user}","branches_url":"https://api.github.com/repos/floriank/openproject/branches{/branch}","tags_url":"https://api.github.com/repos/floriank/openproject/tags","blobs_url":"https://api.github.com/repos/floriank/openproject/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/floriank/openproject/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/floriank/openproject/git/refs{/sha}","trees_url":"https://api.github.com/repos/floriank/openproject/git/trees{/sha}","statuses_url":"https://api.github.com/repos/floriank/openproject/statuses/{sha}","languages_url":"https://api.github.com/repos/floriank/openproject/languages","stargazers_url":"https://api.github.com/repos/floriank/openproject/stargazers","contributors_url":"https://api.github.com/repos/floriank/openproject/contributors","subscribers_url":"https://api.github.com/repos/floriank/openproject/subscribers","subscription_url":"https://api.github.com/repos/floriank/openproject/subscription","commits_url":"https://api.github.com/repos/floriank/openproject/commits{/sha}","git_commits_url":"https://api.github.com/repos/floriank/openproject/git/commits{/sha}","comments_url":"https://api.github.com/repos/floriank/openproject/comments{/number}","issue_comment_url":"https://api.github.com/repos/floriank/openproject/issues/comments{/number}","contents_url":"https://api.github.com/repos/floriank/openproject/contents/{+path}","compare_url":"https://api.github.com/repos/floriank/openproject/compare/{base}...{head}","merges_url":"https://api.github.com/repos/floriank/openproject/merges","archive_url":"https://api.github.com/repos/floriank/openproject/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/floriank/openproject/downloads","issues_url":"https://api.github.com/repos/floriank/openproject/issues{/number}","pulls_url":"https://api.github.com/repos/floriank/openproject/pulls{/number}","milestones_url":"https://api.github.com/repos/floriank/openproject/milestones{/number}","notifications_url":"https://api.github.com/repos/floriank/openproject/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/floriank/openproject/labels{/name}","releases_url":"https://api.github.com/repos/floriank/openproject/releases{/id}","created_at":"2015-01-19T11:56:20Z","updated_at":"2015-02-16T15:38:38Z","pushed_at":"2015-02-23T15:07:00Z","git_url":"git://github.com/floriank/openproject.git","ssh_url":"git@github.com:floriank/openproject.git","clone_url":"https://github.com/floriank/openproject.git","svn_url":"https://github.com/floriank/openproject","homepage":"https://www.openproject.org","size":64410,"stargazers_count":0,"watchers_count":0,"language":"Ruby","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"dev"}},"base":{"label":"opf:dev","ref":"dev","sha":"b6e84f9c499f319ae3f92e353ba7193d3092e556","user":{"login":"opf","id":1756674,"avatar_url":"https://avatars.githubusercontent.com/u/1756674?v=3","gravatar_id":"","url":"https://api.github.com/users/opf","html_url":"https://github.com/opf","followers_url":"https://api.github.com/users/opf/followers","following_url":"https://api.github.com/users/opf/following{/other_user}","gists_url":"https://api.github.com/users/opf/gists{/gist_id}","starred_url":"https://api.github.com/users/opf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opf/subscriptions","organizations_url":"https://api.github.com/users/opf/orgs","repos_url":"https://api.github.com/users/opf/repos","events_url":"https://api.github.com/users/opf/events{/privacy}","received_events_url":"https://api.github.com/users/opf/received_events","type":"Organization","site_admin":false},"repo":{"id":6899875,"name":"openproject","full_name":"opf/openproject","owner":{"login":"opf","id":1756674,"avatar_url":"https://avatars.githubusercontent.com/u/1756674?v=3","gravatar_id":"","url":"https://api.github.com/users/opf","html_url":"https://github.com/opf","followers_url":"https://api.github.com/users/opf/followers","following_url":"https://api.github.com/users/opf/following{/other_user}","gists_url":"https://api.github.com/users/opf/gists{/gist_id}","starred_url":"https://api.github.com/users/opf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opf/subscriptions","organizations_url":"https://api.github.com/users/opf/orgs","repos_url":"https://api.github.com/users/opf/repos","events_url":"https://api.github.com/users/opf/events{/privacy}","received_events_url":"https://api.github.com/users/opf/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/opf/openproject","description":"OpenProject is a web-based project management system built on Ruby on Rails","fork":false,"url":"https://api.github.com/repos/opf/openproject","forks_url":"https://api.github.com/repos/opf/openproject/forks","keys_url":"https://api.github.com/repos/opf/openproject/keys{/key_id}","collaborators_url":"https://api.github.com/repos/opf/openproject/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/opf/openproject/teams","hooks_url":"https://api.github.com/repos/opf/openproject/hooks","issue_events_url":"https://api.github.com/repos/opf/openproject/issues/events{/number}","events_url":"https://api.github.com/repos/opf/openproject/events","assignees_url":"https://api.github.com/repos/opf/openproject/assignees{/user}","branches_url":"https://api.github.com/repos/opf/openproject/branches{/branch}","tags_url":"https://api.github.com/repos/opf/openproject/tags","blobs_url":"https://api.github.com/repos/opf/openproject/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/opf/openproject/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/opf/openproject/git/refs{/sha}","trees_url":"https://api.github.com/repos/opf/openproject/git/trees{/sha}","statuses_url":"https://api.github.com/repos/opf/openproject/statuses/{sha}","languages_url":"https://api.github.com/repos/opf/openproject/languages","stargazers_url":"https://api.github.com/repos/opf/openproject/stargazers","contributors_url":"https://api.github.com/repos/opf/openproject/contributors","subscribers_url":"https://api.github.com/repos/opf/openproject/subscribers","subscription_url":"https://api.github.com/repos/opf/openproject/subscription","commits_url":"https://api.github.com/repos/opf/openproject/commits{/sha}","git_commits_url":"https://api.github.com/repos/opf/openproject/git/commits{/sha}","comments_url":"https://api.github.com/repos/opf/openproject/comments{/number}","issue_comment_url":"https://api.github.com/repos/opf/openproject/issues/comments{/number}","contents_url":"https://api.github.com/repos/opf/openproject/contents/{+path}","compare_url":"https://api.github.com/repos/opf/openproject/compare/{base}...{head}","merges_url":"https://api.github.com/repos/opf/openproject/merges","archive_url":"https://api.github.com/repos/opf/openproject/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/opf/openproject/downloads","issues_url":"https://api.github.com/repos/opf/openproject/issues{/number}","pulls_url":"https://api.github.com/repos/opf/openproject/pulls{/number}","milestones_url":"https://api.github.com/repos/opf/openproject/milestones{/number}","notifications_url":"https://api.github.com/repos/opf/openproject/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/opf/openproject/labels{/name}","releases_url":"https://api.github.com/repos/opf/openproject/releases{/id}","created_at":"2012-11-28T09:59:11Z","updated_at":"2015-02-23T15:13:29Z","pushed_at":"2015-02-23T15:13:32Z","git_url":"git://github.com/opf/openproject.git","ssh_url":"git@github.com:opf/openproject.git","clone_url":"https://github.com/opf/openproject.git","svn_url":"https://github.com/opf/openproject","homepage":"https://www.openproject.org","size":168476,"stargazers_count":517,"watchers_count":517,"language":"Ruby","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":226,"mirror_url":null,"open_issues_count":59,"forks":226,"open_issues":59,"watchers":517,"default_branch":"dev"}},"_links":{"self":{"href":"https://api.github.com/repos/opf/openproject/pulls/2611"},"html":{"href":"https://github.com/opf/openproject/pull/2611"},"issue":{"href":"https://api.github.com/repos/opf/openproject/issues/2611"},"comments":{"href":"https://api.github.com/repos/opf/openproject/issues/2611/comments"},"review_comments":{"href":"https://api.github.com/repos/opf/openproject/pulls/2611/comments"},"review_comment":{"href":"https://api.github.com/repos/opf/openproject/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/opf/openproject/pulls/2611/commits"},"statuses":{"href":"https://api.github.com/repos/opf/openproject/statuses/fb56e927fbc1402547a48c127da41a8c00549356"}}}}