- Student Being Reviewed:
- Reviewer:
- Classroom:
| Item to review |
Feedback (yes/no) |
|
1. Practices best practices working with APIs. (The .env is not checked into git, and no API token was directly used in the Ruby code without ENV.)
|
yes/no
|
|
2. Practices error handling with APIs. (For all pieces of code that make an API call, it handles API requests that come back with errors/error status codes appropriately.)
|
yes/no
|
|
3. Implements inheritance and inheritance idioms. There is a Recipient class. User and Channel inherit from Recipient. In Recipient, there are appropriate methods defined that are used in both User and Channel. Some may be implemented. Some may be template methods.
|
yes/no
|
4. Practices clean code.
- lib/slack.rb only interacts with Workspace (to show a separation of responsibilities).
- Complex logic is broken into smaller helper methods. (There aren’t more than one or two methods that are 30 lines or more)
|
yes/no
|
|
5. Practices instance methods vs. class methods appropriately. (The methods to list all Channels or Users is a class method within those respective classes.)
|
yes/no
|
|
6. Practices best practices for testing. (The project has and uses VCR mocking when running tests, and can run offline.)
|
yes/no
|
|
7. Practices writing tests. (The User, Channel, and Workspace classes have unit tests.)
|
yes/no
|
|
8. There are also tests for sending messages (the location of these tests may differ, but is likely in Recipient)
|
yes/no
|
|
9. Practices git with at least 15 small commits and meaningful commit messages
|
yes/no
|
| Functional Requirement
|
Feedback (yes/no)
|
1. As a user of the CLI program, I can list users and channels with the commands list users and list channels
|
yes/no
|
2. As a user of the CLI program, I can select users and channels with the commands select user and select channel
|
yes/no
|
3. As a user of the CLI program, I can show the details of a selected user or channel with the command details
|
yes/no
|
4. As a user of the CLI program, when I input something inappropriately, the program runs without crashing. Example commands to try are do_something, or select user followed by Mr. Fakename
|
yes/no
|
At the end of this review, don't forget to commit and push your review. Otherwise, instructors won't be able to see your work.