Skip to content

Add all contributors #688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
5 tasks
kjaymiller opened this issue May 18, 2025 · 0 comments
Open
5 tasks

Add all contributors #688

kjaymiller opened this issue May 18, 2025 · 0 comments
Labels
good first issue Good for newcomers

Comments

@kjaymiller
Copy link
Contributor

kjaymiller commented May 18, 2025

Description

We should implement the all-contributors specification to recognize all people who contribute to our project, not just code contributors. This will help us acknowledge various types of contributions including documentation, design, testing, and more.

Motivation

  • Properly recognize all contributors regardless of contribution type
  • Create a more inclusive environment that values all forms of contribution
  • Provide clear documentation of who has helped with the project and how
  • Encourage more diverse contributions by showing we value all types of help

Implementation Plan

  • Initialize the specification: npx all-contributors init
  • Add existing contributors using the CLI: npx all-contributors add <username> <contribution-type>
  • Set up a .all-contributorsrc configuration file
  • Add the contributors table to our README.md
  • Document the process for adding new contributors in CONTRIBUTING.md

Additional Details

  • Contribution types to recognize: code, doc, design, bug, test, ideas, review, talk, tutorial, etc.
  • CLI will maintain both .all-contributorsrc and README.md files automatically
  • We can configure the bot to automatically suggest adding new contributors

Questions

  • Should we use the all-contributors bot for automated PRs?
  • What emoji/acknowledgment style should we use for the contributors table?
  • Should we include the contributors table at the top or bottom of the README?

Resources

@lazouich lazouich added the good first issue Good for newcomers label May 18, 2025
@kjaymiller kjaymiller added this to the PyCon Sprints 2025 milestone May 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants