Team3 Chatbot Submission (Slack)

[Alex-Ying]

Members:
Alex Ying - [email protected]
Mridul Mittal - [email protected]

Basic communication established between Slack and Python backend

[AbdullahSuri]

1. Change Granularity
   Observation: Commits are well-segmented, each with a distinct purpose, facilitating easy tracking of changes.

2. Code Functionality
   Requirements Fulfillment: The Slack bot implementation meets the basic communication requirements specified.
   Logic Flow: The logic for message handling is straightforward and effective, though consideration for dynamic user interaction might enhance usability.

3. Readability & Structure
   Naming Conventions: Names are intuitive and contribute to the readability of the code.
   Modularity: Functions like message_hello are well-designed, focusing on single responsibilities, which simplifies maintenance.

4. Standards Compatibility
   Linting: The code adheres to Python standards as evidenced by linting configuration.
   API Exposure: Proper encapsulation is used, exposing only necessary parts of the Slack API.

5. Testing
   Coverage: The test suite includes basic tests but lacks coverage for the Slack interactions.
   Readability: Existing tests clearly validate basic functionalities; however, integration tests involving Slack API responses could be beneficial.

Additional Note:
Consider adding more detailed error handling and expanding the README for better guidance on setup and operation.

[kyotov]

There are major deficiencies here. Some:

• How is each file in your PR connected to the task at hand?
  • You should not have files that are irrelevant to the task.
• Make sure files that should be .gitignore are in .gitignore
  • E.g. .DS_Store
• Make sure secrets are not checked in!
• Make sure there is a clear and separated API!

Address these before I look again.

[AbdullahSuri]

1. Change Granularity:
   The commits are well-defined and clearly indicate the development workflow. Each module and its purpose are logically separated, which enhances both understanding and navigation of the codebase.

2. Code Functionality:
   The implementation across the slackbot.py, api.py, hello.py, and test_slack.py files demonstrates that the bot functions as intended, effectively handling message events and responses via Slack. Integration across multiple Python files indicates that the bot setup is modular and leverages environment variables appropriately for configuration.

3. Readability & Structure:
   Code across the various modules is easy to follow, with a logical structure that enhances understanding. Each file has a clear purpose, contributing to a well-organized codebase.
   Consider prefixing private or internal-use Python files with an underscore to clarify their intended use and discourage direct access by end-users or other developers.

4. Standards Compatibility:
   The code adheres to Python standards as evidenced by linting configuration as it previously did.

5. Testing
   The existing tests are comprehensive, covering both standard operations and edge cases, which ensures the robustness of the Slack bot functionality. Mock objects and patching are used effectively to isolate and verify the functionality of individual components.