Skip to content

Commit

Permalink
feat(docs): add project-claude-advice.md with task prompts
Browse files Browse the repository at this point in the history
- Create new file with improved task pointnetwork#1 prompt
- Add new task pointnetwork#2 prompt for structured technical overview
- Include additional task ideas based on git log analysis
  • Loading branch information
sswam committed Sep 21, 2024
1 parent 2402c90 commit c7cea93
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions gens/project-claude-advice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Your prompt for task #1 is already quite good. Here are some suggestions for improving it and creating a prompt for task #2, along with additional ideas for utilizing git log messages:

Task #1: Technical Diary (improved version)
"Based on the provided git log messages, please create a chronological technical diary of the project's development. This diary should:
1. Be up to 10 pages or 6000 words long.
2. Describe the evolution of the project over time.
3. Mention and explain the different tools, apps, libraries, and tasks involved.
4. Speculate on the reasons behind certain development decisions or feature implementations.
5. Highlight any major milestones, challenges, or pivots in the project's direction.
6. Include any patterns or trends you notice in the development process."

Task #2: Structured Technical Overview
"Using the git log messages, please create a structured technical overview of the project. This overview should:
1. Outline the main components and features of the project.
2. Provide a high-level architecture of the system, if discernible from the commits.
3. List and briefly describe all major tools, libraries, and frameworks used.
4. Identify the primary programming languages and technologies employed.
5. Summarize the key functionalities implemented throughout the project's lifecycle.
6. Highlight any significant optimizations, refactoring, or architectural changes.
7. Mention any testing, deployment, or DevOps practices evident from the commits."

Additional tasks based on git log messages:

1. Contribution Analysis: "Analyze the frequency and impact of contributions from different team members, identifying key contributors and their areas of expertise."

2. Bug and Issue Tracking: "Create a summary of major bugs and issues addressed throughout the project, including their resolution methods."

3. Feature Timeline: "Develop a timeline of major feature implementations, showing when key functionalities were added to the project."

4. Code Quality Evolution: "Trace the evolution of code quality practices, such as the introduction of linting, testing, or code review processes."

5. Dependencies and Integrations: "Compile a list of all external dependencies and integrations added to the project over time, including when they were introduced and potentially why."

6. Performance Optimization History: "Summarize the history of performance optimizations made throughout the project, including the techniques used and their impacts."

7. Security Enhancements: "Identify and describe any security-related changes or enhancements made during the project's development."

8. Refactoring Patterns: "Analyze the commit history to identify major refactoring efforts, describing the motivations behind them and their outcomes."

These prompts and tasks should help you extract valuable insights from your project's git log messages, providing a comprehensive view of your project's development history and technical aspects.

0 comments on commit c7cea93

Please sign in to comment.