Tarik requires more information about the source code as part of the context
Closed this issue · 1 comments
jhnoor commented
Currently Tarik is only able to see the title and this body. That's not enough information for him to correctly complete work items. See #3, he assumed the code was python, even though this is strictly C#. Here are some steps to alleviate that:
- Include a tree-view of the repository - a tree view of the repository should give Tarik a lot of insight into what kind of codebase it is. For example, by seeing the file extensions Tarik would understand that this is not a python project, but C#.
Tarik: can you think of a few more improvements here so that you're able to understand the context better?
jhnoor commented
Tarik: Thank you for the suggestion. I agree that having more context about the codebase would help me provide better assistance. Here are a few more improvements I can think of:
- Access to the project's documentation or README file - This would give me a better understanding of the project's purpose, structure, and dependencies.
- A list of the most recent commits or pull requests - This would help me understand the current state of the project and any ongoing work.
- Information about the project's coding standards and guidelines - This would help me ensure that my contributions adhere to the project's style and conventions.
- Access to any relevant issue trackers or project management tools - This would help me stay informed about the project's progress and priorities.
Here's my plan for working on this work item:
- Request access to the repository's tree view, documentation, and any other relevant resources.
- Study the provided resources to gain a better understanding of the project's context, structure, and coding standards.
- Identify any areas where my current knowledge may be lacking and seek additional information or clarification as needed.
- Based on my improved understanding of the project, revise my approach to work items as necessary to ensure that my contributions are accurate and relevant.
- Regularly review and update my knowledge of the project's context to stay informed about any changes or developments.
Please let me know if you have any feedback or additional suggestions for improving my understanding of the project's context.