)]}'
{"code-review-standard.rst":[{"author":{"_account_id":11685,"name":"Stephen Balukoff","email":"stephen@balukoff.com","username":"sbalukoff"},"change_message_id":"c50e068a61c901ce0152b7c1537080ff6eeecc6d","unresolved":false,"context_lines":[{"line_number":2,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":3,"context_line":"This document is used for code review reference, we follow the"},{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_6cefbc87","line":5,"updated":"2014-11-25 00:38:55.000000000","message":"We should also make reference to our own HACKING.rst and CONSTITUTION.rst files in the root of the Octavia repository.","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":10477,"name":"min wang","email":"swiftwangster@gmail.com","username":"minwang"},"change_message_id":"1225cdca18d7b124f705c5d112e9e3188a1b226e","unresolved":false,"context_lines":[{"line_number":2,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":3,"context_line":"This document is used for code review reference, we follow the"},{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_cb62a815","line":5,"in_reply_to":"5a890539_6cefbc87","updated":"2014-12-02 00:17:23.000000000","message":"if you want to move most of the content in the document into hacking.rst, i guess that we dont need to make the reference to HACKING.rst and CONSTITUTION.rst","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":11685,"name":"Stephen Balukoff","email":"stephen@balukoff.com","username":"sbalukoff"},"change_message_id":"1b73bf053620755ab06e15775abc1b01aa52897a","unresolved":false,"context_lines":[{"line_number":2,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":3,"context_line":"This document is used for code review reference, we follow the"},{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_531dfc61","line":5,"in_reply_to":"5a890539_896e9194","updated":"2014-12-05 04:10:48.000000000","message":"So, I hear your, but don\u0027t agree on linking to external documents. Yes, it can end up leading one down a rats nest of links to other documents, but the alternative is that you\u0027re repeating yourself (ie. not DRY), and that anything you write is likely to get stale compared to \"live\" documents. Does that make sense?\n\nIn any case, there are guides here and elsewhere for standards to follow when writing code, but so far, no standards that one should follow when reviewing code. More on that in the next comment.","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":10477,"name":"min wang","email":"swiftwangster@gmail.com","username":"minwang"},"change_message_id":"0ec3c7b668c5884ce71d3f4b616b81af56c75382","unresolved":false,"context_lines":[{"line_number":2,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":3,"context_line":"This document is used for code review reference, we follow the"},{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_896e9194","line":5,"in_reply_to":"5a890539_9df6215c","updated":"2014-12-03 20:19:45.000000000","message":"i will try to move the content in the doc into hacking , make sure the content there is complete and unique. I noticed that in the hacking doc, there are some links for people to read, the reason that i put some content which already exists in other link in one page is try to summarize those important points so people can pick it up very quickly. When i read some the docs in openstack, it happens that one page links to another, after you click a few links, you are lost but too much information there. My view of a handbook is to be simple, concise and easy to pick, if someone wants to learn more, we can put the reference link in the bottom of the page.","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":11685,"name":"Stephen Balukoff","email":"stephen@balukoff.com","username":"sbalukoff"},"change_message_id":"9ddfabcdc270ef37ae5cdc880300c28c310cd434","unresolved":false,"context_lines":[{"line_number":2,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":3,"context_line":"This document is used for code review reference, we follow the"},{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_9df6215c","line":5,"in_reply_to":"5a890539_cb62a815","updated":"2014-12-02 04:59:22.000000000","message":"I don\u0027t want to duplicate what is already referenced in the generalized OpenStack wiki... as a rule of thumb, anything we check into the Octavia wiki should be unique to Octavia (and copy-pasting from a generalized wiki just means that our \"local copy\" is just going to get out of date over time).","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":11685,"name":"Stephen Balukoff","email":"stephen@balukoff.com","username":"sbalukoff"},"change_message_id":"c50e068a61c901ce0152b7c1537080ff6eeecc6d","unresolved":false,"context_lines":[{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"},{"line_number":9,"context_line":"- [H903] Use only UNIX style newlines (\\n), not Windows style (\\r\\n)"},{"line_number":10,"context_line":"- Wrap long lines in parentheses,avoid backslash for line continuation."}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_4cf6805e","line":7,"updated":"2014-11-25 00:38:55.000000000","message":"So, this actually feels like it should be in the HACKING.rst file in our repository. Could you take a stab at updating that file instead of listing these here?  (We want there to be one source of truth on this.)\n\nI see the code review standard being more a guide for etiquette for reviewers in terms of what is expected of them when they review. The list of code standards that can be tested via automated means (ie. this is what pep8 does) should be listed elsewhere.\n\nFor those things that aren\u0027t as easily checked in an automated way (ex. \"do not shadow built-in or reserved word\"), I still think these should be listed in the HACKING.rst file.\n\nAnyway, I see HACKING.rst being a guide for developers writing code on the project. And I see this document being a guide for reviewers of code written for the project. (ie. it should be more about what to do with gerrit than what the coding standards actually are.)","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":10477,"name":"min wang","email":"swiftwangster@gmail.com","username":"minwang"},"change_message_id":"0ec3c7b668c5884ce71d3f4b616b81af56c75382","unresolved":false,"context_lines":[{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"},{"line_number":9,"context_line":"- [H903] Use only UNIX style newlines (\\n), not Windows style (\\r\\n)"},{"line_number":10,"context_line":"- Wrap long lines in parentheses,avoid backslash for line continuation."}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_e91395b5","line":7,"in_reply_to":"5a890539_1db95179","updated":"2014-12-03 20:19:45.000000000","message":"since HACKING,rst is parsed for keywords, yes, i agree, we will keep its name here.\n\nTell me if i am wrong,but i did not find guideline for reviewers in openstack wiki page, yes, there are some links that point it out the principle that we need to follow, to me it is more theoretical study, if we can list something more practical and detailed for people to follow in this project, will it save our programmers\u0027 time for review in the long run?","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":10477,"name":"min wang","email":"swiftwangster@gmail.com","username":"minwang"},"change_message_id":"1225cdca18d7b124f705c5d112e9e3188a1b226e","unresolved":false,"context_lines":[{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"},{"line_number":9,"context_line":"- [H903] Use only UNIX style newlines (\\n), not Windows style (\\r\\n)"},{"line_number":10,"context_line":"- Wrap long lines in parentheses,avoid backslash for line continuation."}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_6baa941b","line":7,"in_reply_to":"5a890539_4cf6805e","updated":"2014-12-02 00:17:23.000000000","message":"I can try to update the hacking.rst, is it possible that we change the name hacking.rst to be  something like code_standard.rst which is easier for programmers to catch. I understand in this project there are a lot of programmers who have lots of openstack or open source project experience, but I think along with the development of this project, there are more and more programmers will join in, for people like them( for instance, i am one of them ) , the more direct of the name , the quicker or easier for them to search files. \n\nAlso if you could list some of the criteria that you use to review code, it would be helpful for me to do further research.\n\n\nFinally, thanks a lot for your time and suggestion for this document, I really appreciate it.","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":11685,"name":"Stephen Balukoff","email":"stephen@balukoff.com","username":"sbalukoff"},"change_message_id":"9ddfabcdc270ef37ae5cdc880300c28c310cd434","unresolved":false,"context_lines":[{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"},{"line_number":9,"context_line":"- [H903] Use only UNIX style newlines (\\n), not Windows style (\\r\\n)"},{"line_number":10,"context_line":"- Wrap long lines in parentheses,avoid backslash for line continuation."}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_1db95179","line":7,"in_reply_to":"5a890539_6baa941b","updated":"2014-12-02 04:59:22.000000000","message":"So, yes, there\u0027s a learning curve when it comes to working on OpenStack projects-- but I don\u0027t think we really help that learning curve by inventing new standards where other OpenStack projects are all following one particular standard (which isn\u0027t a bad one). Also, I think that HACKING.rst might actually be parsed for certain keywords by automated systems like jenkins or tempest-- so actually listing exceptions to rules, or which rules we want to follow in a specific, parseable format is important for continuous integration.\n\nBut Doug\u0027s point is also valid and got me thinking: What we\u0027re after here might better be done in a generalized OpenStack wiki page. If a guideline for reviewers doesn\u0027t already exist there... well, I\u0027m sure people have a process, and I know there\u0027s a certain etiquette when it comes to reviewing that people who have been working on OpenStack for a while follow. Maybe we should just see about writing that down for everyone working on OpenStack projects?","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"},{"author":{"_account_id":11685,"name":"Stephen Balukoff","email":"stephen@balukoff.com","username":"sbalukoff"},"change_message_id":"1b73bf053620755ab06e15775abc1b01aa52897a","unresolved":false,"context_lines":[{"line_number":4,"context_line":"OpenStack Style Commandments:http://docs.openstack.org/developer/hacking/"},{"line_number":5,"context_line":"Fuel/Code Review Rules:https://wiki.openstack.org/wiki/Fuel/Code_Review_Rules"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"General"},{"line_number":8,"context_line":"-----------------------------"},{"line_number":9,"context_line":"- [H903] Use only UNIX style newlines (\\n), not Windows style (\\r\\n)"},{"line_number":10,"context_line":"- Wrap long lines in parentheses,avoid backslash for line continuation."}],"source_content_type":"text/x-rst","patch_set":1,"id":"5a890539_d002c20b","line":7,"in_reply_to":"5a890539_e91395b5","updated":"2014-12-05 04:10:48.000000000","message":"I\u0027ve not seen any guidelines for reviews in the OpenStack wiki anywhere either. And the more I think about what I think you\u0027re trying to do with this commit, I suspect the content we\u0027d put in this kind of guideline document should probably end up in the generalized OpenStack wiki as a guide that all reviewers (especially ones new to gerrit) should follow when reviewing code, eh.\n\nI have no idea whether reviewers will read it, though, nor whether it will save them time. Obviously, if you think your time is better spent on other things, please work on those other things!","commit_id":"688517a969e3e55167753aa111ea7c6b5c80e2a4"}]}