|
| 1 | +# Claude Prompt: Generate Contribution Summary |
| 2 | + |
| 3 | +Use this prompt in any repository where you want to generate a comprehensive contribution summary similar to CONTRIBUTIONS.md in this repository. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## Prompt |
| 8 | + |
| 9 | +I'd like you to create a comprehensive summary of all my contributions to this repository. Here's what I need: |
| 10 | + |
| 11 | +**Step 1: Gather My Commits** |
| 12 | + |
| 13 | +First, find all non-merge commits I've made to this repository. My author identities may include: |
| 14 | +- [Your name as it appears in commits] |
| 15 | +- [Your email address(es)] |
| 16 | +- [Any other variations of your GitHub username/email] |
| 17 | + |
| 18 | +Please analyze the git history and identify all unique pull requests associated with my commits. |
| 19 | + |
| 20 | +**Step 2: Organize by Contribution Type** |
| 21 | + |
| 22 | +Rather than listing commits chronologically, I want you to organize my work into thematic categories based on the nature of the contributions. Common categories might include: |
| 23 | +- Infrastructure/DevOps/CI/CD work |
| 24 | +- API development or protocol changes |
| 25 | +- Testing improvements and reliability work |
| 26 | +- Build system and tooling |
| 27 | +- Security fixes and vulnerability patches |
| 28 | +- Documentation |
| 29 | +- Developer experience improvements |
| 30 | +- Feature development |
| 31 | +- Performance optimizations |
| 32 | +- Bug fixes |
| 33 | + |
| 34 | +Identify the categories that best represent my work in this repository. |
| 35 | + |
| 36 | +**Step 3: Write the Summary** |
| 37 | + |
| 38 | +For each category, write a comprehensive paragraph (not bullet points) that: |
| 39 | +- Uses active voice with my name as the subject (e.g., "Caden implemented..." not "Work was done...") |
| 40 | +- Provides context about WHY the work mattered, not just WHAT was changed |
| 41 | +- Groups related work together to tell a coherent story |
| 42 | +- Includes inline markdown links to pull requests where specific work is mentioned |
| 43 | + - Format: `([#1234](https://github.com/OWNER/REPO/pull/1234))` |
| 44 | +- Is written for someone less familiar with the repository internals |
| 45 | + |
| 46 | +**Step 4: Create the File** |
| 47 | + |
| 48 | +Create a file called `CONTRIBUTIONS.md` in the repository root with: |
| 49 | +- A title including my name |
| 50 | +- An introduction explaining the document's purpose |
| 51 | +- One section per contribution category (## heading) |
| 52 | +- Each section containing a detailed paragraph as described above |
| 53 | +- A footer noting the timespan of contributions |
| 54 | + |
| 55 | +**Style Guidelines:** |
| 56 | +- Write in complete sentences and paragraphs, not bullet points |
| 57 | +- Be specific about technical details but explain them accessibly |
| 58 | +- Every PR reference should be a clickable markdown link |
| 59 | +- Use active voice throughout |
| 60 | +- Focus on impact and outcomes, not just changes made |
| 61 | +- Make it digestible for someone unfamiliar with the codebase |
| 62 | + |
| 63 | +**Example of good writing style:** |
| 64 | + |
| 65 | +> Caden implemented a comprehensive certificate lifecycle management system for Managed Service Identity certificates used in MIWI clusters. He created automated refresh logic that triggers during cluster update, admin update ([#4222](https://github.com/Azure/ARO-RP/pull/4222)), and maintenance operations ([#4390](https://github.com/Azure/ARO-RP/pull/4390)), with intelligent eligibility checks to only rotate certificates within their renewal window. |
| 66 | +
|
| 67 | +Please start by gathering my commit information and then proceed with the analysis. |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +## Customization Notes |
| 72 | + |
| 73 | +Before using this prompt in a new repository, update: |
| 74 | +1. **Your name/email identities**: Replace the placeholder with your actual git author names and email addresses |
| 75 | +2. **Repository context**: The categories will vary based on the type of project (web app vs. CLI tool vs. library, etc.) |
| 76 | +3. **PR link format**: Ensure the GitHub org/repo name is correct in the example if you want to show a template |
| 77 | + |
| 78 | +## Tips for Best Results |
| 79 | + |
| 80 | +- If you have many commits (>100), consider asking Claude to focus on merged PRs rather than individual commits |
| 81 | +- If the repository uses a different PR numbering system (e.g., Jira tickets), adjust the linking format accordingly |
| 82 | +- If commits don't reference PR numbers, ask Claude to organize by commit themes instead |
| 83 | +- For very large contribution histories, consider breaking it into time periods (e.g., by year) |
0 commit comments