Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 21, 2025

This PR implements the all-contributors project to automatically recognize and display contributors in the README.md file, making it easy to acknowledge community contributions of all types.

What's Added

Contributors Recognition System:

  • Added all-contributors CLI tooling with proper configuration
  • Contributors are displayed in a visual gallery with avatars and contribution types
  • Supports multiple contribution types: code, documentation, ideas, bug reports, design, and more
  • Added contributors badge in the header showing the current contributor count

Integration with Existing Build System:

  • Modified update-readme.js to include the contributors section in the footer
  • Contributors section is automatically preserved when README is regenerated
  • Works seamlessly with the existing README validation workflow

Automation & Workflows:

  • Added GitHub Actions workflow that runs weekly to check for new contributors
  • Manual trigger available for immediate contributor updates
  • Automated pull request creation when contributors are detected

Documentation & Setup:

  • Created package.json with all-contributors scripts for easy management
  • Updated CONTRIBUTING.md to explain the contributor recognition process
  • Added usage instructions and examples for maintainers

Usage Examples

For maintainers to add contributors manually:

# Add a contributor for code contributions
npm run contributors:add -- username code

# Generate the contributors list
npm run contributors:generate

For automated detection:
The weekly GitHub Actions workflow will automatically detect new contributors and create PRs to add them.

Technical Details

  • Uses all-contributors specification v6.26.1
  • Configured for the github/awesome-copilot repository
  • Avatar size: 100px for optimal display
  • Contributors per line: 7 for clean layout
  • No auto-commit to maintain manual control over changes

The implementation includes Christophe Peugnet (@tossnet) as the first recognized contributor for code contributions, and the system is ready to automatically recognize future contributors as they make contributions to the project.

Fixes #205.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/github/github/awesome-copilot/contributors
    • Triggering command: node /home/REDACTED/work/awesome-copilot/awesome-copilot/node_modules/.bin/all-contributors check (http block)
  • https://api.github.com/users/tossnet
    • Triggering command: node /home/REDACTED/work/awesome-copilot/awesome-copilot/node_modules/.bin/all-contributors add tossnet code (http block)

If you need me to access, download, or install something from one of these locations, you can either:


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits August 21, 2025 23:33
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Copilot AI changed the title [WIP] Add all-contributors Add all-contributors to automatically recognize repository contributors Aug 21, 2025
Copilot AI requested a review from aaronpowell August 21, 2025 23:38
@aaronpowell aaronpowell marked this pull request as ready for review August 22, 2025 01:33
Copilot AI review requested due to automatic review settings August 22, 2025 01:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR implements the all-contributors system to automatically recognize and display repository contributors in a visual gallery format. The system enhances community engagement by acknowledging all types of contributions with GitHub profile avatars and contribution badges.

  • Adds all-contributors tooling with configuration for the awesome-copilot repository
  • Integrates contributor recognition into the existing README generation workflow
  • Sets up automated weekly checks for new contributors via GitHub Actions

Reviewed Changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
update-readme.js Modified footer template to include the contributors section with badges and gallery
package.json Added all-contributors CLI dependency and npm scripts for contributor management
README.md Updated to include contributor badge in header and full contributors gallery in footer
CONTRIBUTING.md Added contributor recognition section explaining the all-contributors system
.github/workflows/contributors.yml Created automated workflow for weekly contributor detection and PR creation
.all-contributorsrc Configuration file with all current contributors and project settings

@aaronpowell aaronpowell merged commit cdc5104 into main Aug 22, 2025
5 checks passed
@aaronpowell aaronpowell deleted the copilot/fix-205 branch August 22, 2025 01:36
iletai pushed a commit to iletai/awesome-copilot that referenced this pull request Sep 3, 2025
…rs (github#208)

* Initial plan

* Add all-contributors setup with contributor recognition

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

* Finalize all-contributors setup and update documentation

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

* Add @aaronpowell as a contributor

* Add @mubaidr as a contributor

* Add @digitarald as a contributor

* Add @mbianchidev as a contributor

* generating the current list

* playing with emojis

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: Aaron Powell <me@aaron-powell.com>
Co-authored-by: all-contributors-bot <all-contributors-bot@example.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add all-contributors

2 participants