Skip to content

Latest commit

 

History

History
118 lines (67 loc) · 5.51 KB

BLOT_REVIEW.md

File metadata and controls

118 lines (67 loc) · 5.51 KB

Reviewing Blots

This document describes how to review a Blot submission. It corresponds to the this file on how to make a Blot submission.

Submission Criteria

The primary question to have in mind as a reviewer is "Did this person apply earnest effort in pushing themselves to learn something new?"

The general criteria is that the art piece is

  • original
  • beautiful/interesting to look at
  • algorithmic is some way

The first point is somewhat obvious though still can take some effort to check. Verify that the code was not copied from the gallery or somewhere like Turtle Toy. Also try to evaluate if the user overly relied on ChatGPT or some other LLM. It's acceptable to use these tools but the piece should be more involved than simply asking a single prompt and copying what comes out. If you are on the fence as to whether the program was ai-generated ask the submitter to make some specific changes. Try to specify tasks which may not be easily prompt-able (it's a moving target what these might be). For example if they drew a bunch of straight lines as blades of grass ask them to give the grass some thickness and bends.

The second point about making something beautiful is subjective but can be satisfied at a variety of skill levels. This is also trying to encourage submitters to not just copy algorithms or generic visualizations. By encouraging people to incorporate aesthetics and composition we also encourage them to incorporate more of their individuality and thought.

This last point on being algorithmic is to prevent simply specifiying points in curves manually. To check if something is algorithmic look for the use of functions and variables. This point is clearly satisfied if there is a variable clearly specified that can be adjusted to change a drawing or if drawings are automatically varied through randomness. A piece may not be random on each generation if parameterization is provided through hardcoded variables or if the random seed is set.

Reviewing PRs

Submissions are made as GitHub PRs.

First find an open submission.

Screenshot 2024-07-03 at 2 51 54 PM

A submission with good effort will typically include some comment from the author. You don't have to automatically reject a submission if it doesn't have a description.

Screenshot 2024-07-03 at 2 52 53 PM

Mark the submission as such with the submission label.

Screenshot 2024-07-03 at 2 53 54 PM

Check the submitted files in the Files changed tab.

Screenshot 2024-07-10 at 10 03 14 PM

Make sure the metadata snapshot exists and that the snapshots folder is named snapshots.

The metadata in the above example is

/*
@title: BinaryComputer
@author: NotRewd
@snapshot: image-1.png
*/

The JavaScript file should be named index.js.

There can be no spaces in any of the folder or filenames.

If there are any errors you can note them to the submitter and ask for corrections. If an error is small (like a misreferenced filename) I sometimes just fix it for the submitter. Many submitters are new and the mechanics of GitHub (while a great skill) are not the most important thing about starting to code.

Review the submission for the above submission criteria. If you find the submission doesn't meet the criteria explain how so to the submitter in the Conversation tab.

If the submission is close to being acceptable then request the user make some specific changes.

If specific changes can not be suggested that make the submission acceptable then close the PR. It is nice to give some positive encouragement to the submitter and let them know they can submit again in the future.

Requesting changes should be done using the "Code Review" GitHub feature, marking "Request changes" for any PR that isn't ready to be merged:

Accepting PRs

To accept a PR.

Apply the approved label.

Screenshot 2024-07-10 at 10 09 13 PM

Comment in the conversation what you appreciate about the piece. Congratulate the Hack Clubber and provide them with the order link. You may still make suggestions about ways to improve the piece too or offer challenges. Here is an example comment:

I like how you rendered a simple geometric element in perspective and then transformed it into a recognizable and some what whimsical object. Your code is also very well organized.

Congrats this definitely earns a Blot. You can order it [here](https://airtable.com/appv0BzBY2APyIXj6/shrhpWVXN5imMzUmw). 

Do you think you could tie together the code that appears on the screen with the object in the viewing window? Maybe you could write a programming language for this computer?

The order link is

https://airtable.com/appv0BzBY2APyIXj6/shrhpWVXN5imMzUmw

It's best to hyperlink it.

Merge the PR.

The best practice when merging PRs is to checkout the branch locally to make sure everything still runs properly. After merging check the gallery to make sure the gallery image is referenced properly.