Add examples and screenshots to CONTRIBUTING.md #5
Description
Improve Contributing Guide
Help make it easier for new contributors by adding concrete examples and visuals!
What to do:
Enhance CONTRIBUTING.md with:
- Screenshot showing how to fork the repo
- Screenshot showing how to create a branch
- Example of a good commit message vs bad commit message
- Step-by-step guide for submitting your first PR
- Common issues and how to fix them (e.g., merge conflicts)
- Tips for writing good PR descriptions
Requirements:
- Clear, beginner-friendly language
- Visual examples (screenshots or annotated images)
- Tested instructions (try following them yourself!)
- Links to helpful resources (GitHub docs, Git tutorials)
Example additions:
Good commit message:
Add social share buttons to project pages
Created ShareButtons.astro component
Added Twitter, LinkedIn, Facebook share links
Styled with Tailwind for consistency
Tested on mobile and desktop
Bad commit message:
fixed stuff
Why this helps:
First-time contributors often feel intimidated. Clear docs with examples make contributing accessible to everyone!
Nice to have:
- GIF showing the fork → clone → edit → PR workflow
- Troubleshooting section for common errors