Skip to content

Instantly share code, notes, and snippets.

@aelliott1485
Forked from 5chdn/AutoReviewComments.md
Last active February 15, 2019 18:16
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save aelliott1485/63dabed9b0093c436659bc4f965e0d18 to your computer and use it in GitHub Desktop.
Save aelliott1485/63dabed9b0093c436659bc4f965e0d18 to your computer and use it in GitHub Desktop.
AutoReviewComments for CodeReview.SE, import this to your plugin.

###[Q] title about CR goals What task does this code accomplish? Please tell us, and also make that the title of the question via [edit]. Maybe you missed the placeholder on the title element: "State the task that your code accomplishes. Make your title distinctive.". Also from How to Ask: "State what your code does in your title, not your main concerns about it.".

###[Q] not workingg Please inform yourself, take the tour, and read up at our help center before posting here. Your question is off-topic because this site is for reviewing working code, not implementing code for you. When you have implemented the code feel free to [edit] your post to include it for a review.

###[Q] broken Unfortunately this post is off-topic for this site. Please read What topics can I ask about here? - note that it states "If you are looking for feedback on a specific working piece of code...then you are in the right place!" Also, when posting your question, there should have been text on the side that read "Your question must contain code that is already working correctly..." When you have fixed the code, please [edit] your post to include the working code and it can be reviewed."

###[Q] untested If you're not sure whether your code works correctly, I'm afraid it's not yet ready for review. $SITENAME$ is for finished code that you believe to be functionally correct.

###[Q] More than one question asked It is preferred if you can post separate questions instead of combining your questions into one. That way, it helps the people answering your question and also others hunting for at least one of your questions. Thanks!

###[Q] Duplicate Closure This question will probably be closed as a duplicate soon. If the answers from the duplicates don't fully address your question please edit it to include why and flag this for re-opening. Thanks!

###[Q] Common title What task does this code accomplish? Please tell us, and also make that the title of the question via [edit]. Maybe you missed the placeholder on the title element: "State the task that your code accomplishes. Make your title distinctive.". Also from How to Ask: "State what your code does in your title, not your main concerns about it.".

###[Q] Edited Title I changed the title so that it describes what the code does per site goals: "State what your code does in your title, not your main concerns about it.". Feel free to [edit] and give it a different title if there is something more appropriate.

###[Q] advice for future code Questions asking for advice about code not yet written are off-topic, as the code is not ready for review.

###[Q] 3rd party code link Maybe you missed the text on the right side when asking: "Your question must contain code that is already working correctly, and the relevant code sections must be embedded in the question." Questions must include the code to be reviewed. Links to code hosted on third-party sites are permissible, but the most relevant excerpts must be embedded in the question itself.

###[Q] Commented with more details When adding additional information you should [edit] your question instead of adding a comment. I have added that information to your post. Learn more about comments including when to comment and when not to in the Help Center page about Comments.

###[Q] merge accounts it appears you have a registered account (as evidenced by the suggested edit), which can be merged with your unregistered account. You can use the contact SE page and request the accounts be merged.

###[Q] don't update code Please do not update the code in your question to incorporate feedback from answers, doing so goes against the Question + Answer style of $SITENAME$. This is not a forum where you should keep the most updated version in your question. Please see what you may and may not do after receiving answers.

###[Q] code rolled back I rolled back your last edit. After getting an answer you are not allowed to change your code anymore. This is to ensure that answers do not get invalidated and have to hit a moving target. If you have changed your code you can either post it as an answer (if it would constitute a code review) or ask a new question with your changed code (linking back to this one as reference). Refer to this post for more information

###[Q] rolled back last edit (Graipher's) I rolled back your last edit. After getting an answer you are not allowed to change your code anymore. This is to ensure that answers do not get invalidated and have to hit a moving target. If you have changed your code you can either post it as an answer (if it would constitute a code review) or ask a new question with your changed code (linking back to this one as reference). Refer to this post for more information

###[A] don't answer off-topic questions Please note, questions involving code that's not working as intended, are off-topic on this site. If OP edits their post to address the problem and make their post on-topic, they make your answer moot. It is advised not to answer such questions. Protip: There are tons of on-topic questions to answer; you'll make more reputation faster if you review code in questions that will get higher view counts for being on-topic.

###[A] don't answer questions likely to be closed Please refrain from answering questions that are likely to get closed.

###[A] link-only answer A link to a solution is welcome, but please ensure your answer is useful without it: add context around the link so your fellow users will have some idea what it is and why it’s there, then quote the most relevant part of the page you're linking to in case the target page is unavailable. Answers that are little more than a link may be deleted.

###[A] Doesn't answer question This does not answer the question the OP posed (i.e. "How can I make it run faster? How can I write it in a OOP paradigm, and will it run faster?"). Please see How do I write a good answer before posting an answer. If you have a related but separate question, you can ask another question and mention this question, or if you have code not working, try [SO].

###[A] alternative solution/ code dump You have presented an alternative solution, but haven't reviewed the code. Please explain your reasoning (how your solution works and why it is better than the original) so that the author and other readers can learn from your thought process. Please read Why are alternative solutions not welcome?

###[A] follow up question This does not really answer the question. If you have a different question, you can ask it by clicking Ask Question, though only if you have working code. This statement would be appropriate as a comment, though you will need to earn 50 reputation points first...

###[A] Answers just to say Thanks! Please don't add "thanks" as answers. Invest some time in the site and you will gain sufficient privileges to upvote answers you like, which is the $SITENAME$ way of saying thank you.

###[A] Nothing but a URL (and isn't spam) Whilst this may theoretically answer the question, it would be preferable to include the essential parts of the answer here, and provide the link for reference.

###[A] Requests to OP for further information This is really a comment, not an answer. With a bit more rep, you will be able to post comments. For the moment I've added the comment for you, and I'm flagging this post for deletion.

###[A] OP using an answer for further information Please use the Post answer button only for actual answers. You should modify your original question to add additional information.

###[A] OP adding a new question as an answer If you have another question, please ask it by clicking the Ask Question button.

###[A] Another user adding a 'Me too!' If you have a NEW question, please ask it by clicking the Ask Question button. If you have sufficient reputation, you may upvote the question. Alternatively, "star" it as a favorite and you will be notified of any new answers.

###[A] NAA self-answer on CR While OPs are encouraged to answer their own questions bear in mind that "Every answer must make at least one insightful observation about the code in the question. Answers that merely provide an alternate solution with no explanation or justification do not constitute valid Code Review answers and may be deleted."...

###[C] Too localized This question appears to be off-topic because it is too localized.

###[EQ] Improper tagging The tags you were using are not appropriate for this question. Please review What are tags, and how should I use them?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment