[Good First Issue] Add QUESTION and FEEDBACK comments throughout the codebase

[creatorrr]

trafficstars

Description

We're looking for new contributors to help improve our codebase by adding insightful questions and feedback comments. This exercise will not only help you familiarize yourself with the project structure but also contribute to making the codebase more accessible for future contributors.

Task

As a new contributor, your task is to go through the codebase following the order recommended in CONTRIBUTING.md and add two types of comments:

1. QUESTION[@<your-github-handle>] ...: For any parts of the code that you find confusing or need clarification on.
2. FEEDBACK[@<your-github-handle>] ...: For any suggestions or improvements you think could be made.

Steps

1. Fork the repository and clone it to your local machine.

2. Set up the development environment as described in CONTRIBUTING.md.

3. Start exploring the codebase in the following order (as recommended in CONTRIBUTING.md): a. Read the main README.md b. Explore the docs/ directory c. Examine docker-compose.yml in the root directory d. Review the deploy/ directory e. Explore the typespec/ directory:

   • Start with the common/ folder
   • Review main.tsp
   • Examine each module sequentially f. Dive into the agents-api/ directory:
   • Review its README.md
   • Examine routers/ for API endpoints
   • Look into models/ for data models g. Review database-related files:
   • Check agents-api/README.md for database schema
   • Explore agents-api/models/ for database queries h. Explore workflow management:
   • Look at agents-api/activities/ for individual workflow steps
   • Review agents-api/workflows/task_execution/ for main workflow logic i. Examine agents-api/tests/ for test cases j. Explore other service directories (integrations-service/, embedding-service/, etc.)

4. As you go through each file, add your QUESTION and FEEDBACK comments where appropriate.

5. Commit your changes with a clear commit message.

6. Push your changes to your fork and create a pull request.

Guidelines

• There are no stupid questions, but please make an effort to understand the code before adding a QUESTION comment.
• FEEDBACK comments should be constructive and aimed at improving the codebase.
• Be specific in your comments. Vague questions or feedback are less helpful.
• If you see existing QUESTION or FEEDBACK comments, feel free to add your thoughts to them.
• Pay special attention to files like agents-api/agents_api/workflows/task_execution/__init__.py, which contain core functionality.

Example

Here's an example of how you might add comments:

In the file agents-api/agents_api/workflows/task_execution/__init__.py on line 10, one could add this:

# Import necessary modules and types

# QUESTION[@new-contributor] Why is the imports_passed_through() used here?
with workflow.unsafe.imports_passed_through():
    from ...activities import task_steps
    from ...activities.execute_integration import execute_integration

    # FEEDBACK[@new-contributor] Consider simplifying this import structure for better readability
    from ...autogen.openapi_model import (
        EmbedStep,
        ErrorWorkflowStep,
        # ...

Expectations

• We expect you to spend at least a few hours exploring the codebase.
• Don't worry if you don't understand everything – that's part of the learning process!
• Your pull request should include changes across multiple files in different directories.
• Be prepared to discuss your questions and feedback in the pull request comments.

Next Steps

Once you've submitted your pull request:

1. Our team will review your comments and may ask for clarifications.
2. We'll provide answers to your questions and discuss your feedback.
3. If your contribution meets our guidelines, we'll merge it into the main branch.

This is a great opportunity to get familiar with our codebase and contribute to its improvement. We look forward to your insights and questions!

Resources

• CONTRIBUTING.md
• Project README
• TypeSpec Documentation
• FastAPI Documentation
• Cozo Documentation
• Temporal Documentation

If you have any questions about this task, feel free to ask in the comments below. Good luck, and happy coding!

[sahilborse]

It is long term work as understanding it require meetings and end points of project.

[JanumalaAkhilendra]

if this issue is still open , I would like to work on it :)

[ijindal1]

This issue is still open @AnujSaha0111 @JanumalaAkhilendra

[TejasNarkhede]

Hi @creatorrr @ijindal1, I'd like to work on this issue. Could you please assign it to me?

[ijindal1]

Hi @TejasNarkhede - which one from the list would you like to work on?

[TejasNarkhede]

Hi @TejasNarkhede - which one from the list would you like to work on?

I will follow the pattern as mentioned in the issue, Starting from docs,docker.... apis etc Adding Questions and Feedback as guided Definitely want to give it a shot!!!

[Dkghuser]

/assign

[Dkghuser]

Hi @ijindal1 , I would like to work on Question part. Please could you assign this issue to me.