Skip to content

Latest commit

 

History

History
128 lines (95 loc) · 4.34 KB

File metadata and controls

128 lines (95 loc) · 4.34 KB

Contributing to Awesome GitHub README Tools

Thank you for your interest in contributing to this awesome list! Your contributions help make this resource better for everyone in the GitHub community.

How to Contribute

Adding a New Tool

  1. Fork this repository and create a new branch from main
  2. Add your tool to the appropriate category in README.md
  3. Follow the format: - [Tool Name](link) - Brief description of what the tool does
  4. Submit a pull request with a clear title and description

Contribution Guidelines

Quality Standards

  • Ensure tools are functional and have clear documentation
  • Avoid duplicate entries - check if the tool is already listed
  • Use proper English with correct grammar and spelling
  • Keep descriptions concise (1-2 sentences maximum)

Formatting Requirements

  • Use the exact format: - [Tool Name](URL) - Description
  • Descriptions should start with a capital letter and end with a period
  • Links should be direct to the main project page (GitHub repo, official website)
  • Maintain alphabetical order within each category when possible

Categories

Please add tools to the most appropriate category:

  • Badges and Shields - Static and dynamic badge generators
  • Profile Views and Counters - Tools to track profile visits
  • GitHub Stats - Statistics and analytics displays
  • Profile Generators - Automated profile README creators
  • README Generators - General README creation tools
  • Dynamic Content - Live updating content (music, blogs, etc.)
  • Metrics and Analytics - Advanced analytics and visualizations
  • Social Media Integration - Social platform connections
  • Technology Stacks - Skill and tech stack displays
  • Typing Effects - Animated text effects
  • Widgets and Embeds - Interactive elements and games
  • CLI Tools - Command-line utilities
  • IDE Extensions - Editor plugins and extensions
  • Templates - README templates and examples

If your tool doesn't fit existing categories, suggest a new category in your pull request.

What We're Looking For

GitHub README enhancement tools
Badge and shield generators
Profile customization utilities
Statistics and metrics tools
Dynamic content generators
CLI tools for README creation
IDE extensions for markdown
Templates and generators

What We're NOT Looking For

❌ General markdown editors
❌ Generic web development tools
❌ Tools unrelated to GitHub READMEs
❌ Paid tools without free tiers
❌ Broken or unmaintained projects
❌ Duplicate entries

Pull Request Process

  1. Search existing issues and PRs to avoid duplicates
  2. Update the Table of Contents if you add a new category
  3. Test all links to ensure they work correctly
  4. Write a clear PR description explaining what you're adding
  5. Be patient - we'll review your contribution as soon as possible

Pull Request Template

When submitting a PR, please include:

## What type of PR is this?
- [ ] Adding a new tool
- [ ] Updating an existing tool
- [ ] Fixing a broken link
- [ ] Improving documentation
- [ ] Other (please specify)

## Tool Details
- **Tool Name**: 
- **Category**: 
- **URL**: 
- **Description**: 

## Checklist
- [ ] I have read the contributing guidelines
- [ ] The tool is actively maintained
- [ ] The link works correctly
- [ ] The description is clear and concise
- [ ] The format matches existing entries
- [ ] I have checked for duplicates

Reporting Issues

If you find:

  • Broken links - Please report them or submit a fix
  • Outdated tools - Let us know so we can remove them
  • Better alternatives - Suggest replacements for outdated tools
  • Categorization issues - Help us organize better

Recognition

Contributors will be recognized in our README and we appreciate every contribution, no matter how small!

Code of Conduct

This project follows GitHub's Community Guidelines. Please be respectful and constructive in all interactions.

Questions?

If you have questions about contributing, feel free to:

  • Open an issue for discussion
  • Contact the maintainer @HenryLok0

Thank you for helping make this awesome list even more awesome! 🎉