-
Notifications
You must be signed in to change notification settings - Fork 872
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Good First Issue] Add QUESTION and FEEDBACK comments throughout the codebase #555
Comments
It is long term work as understanding it require meetings and end points of project. |
if this issue is still open , I would like to work on it :) |
This issue is still open @AnujSaha0111 @JanumalaAkhilendra |
Hi @creatorrr @ijindal1, I'd like to work on this issue. Could you please assign it to me? |
Hi @TejasNarkhede - which one from the list would you like to work on? |
I will follow the pattern as mentioned in the issue, |
…across the codebase
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:
QUESTION[@<your-github-handle>] ...
: For any parts of the code that you find confusing or need clarification on.FEEDBACK[@<your-github-handle>] ...
: For any suggestions or improvements you think could be made.Steps
Fork the repository and clone it to your local machine.
Set up the development environment as described in CONTRIBUTING.md.
Start exploring the codebase in the following order (as recommended in CONTRIBUTING.md):
a. Read the main README.md
b. Explore the
docs/
directoryc. Examine
docker-compose.yml
in the root directoryd. Review the
deploy/
directorye. Explore the
typespec/
directory:common/
foldermain.tsp
f. Dive into the
agents-api/
directory:routers/
for API endpointsmodels/
for data modelsg. Review database-related files:
agents-api/README.md
for database schemaagents-api/models/
for database queriesh. Explore workflow management:
agents-api/activities/
for individual workflow stepsagents-api/workflows/task_execution/
for main workflow logici. Examine
agents-api/tests/
for test casesj. Explore other service directories (
integrations-service/
,embedding-service/
, etc.)As you go through each file, add your QUESTION and FEEDBACK comments where appropriate.
Commit your changes with a clear commit message.
Push your changes to your fork and create a pull request.
Guidelines
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:Expectations
Next Steps
Once you've submitted your pull request:
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
If you have any questions about this task, feel free to ask in the comments below. Good luck, and happy coding!
The text was updated successfully, but these errors were encountered: