docs: expand Contributors Hall of Fame (Closes #55) - #80
Conversation
amir-hameed-mir
left a comment
There was a problem hiding this comment.
Requested Changes
Thanks for taking up Issue #55 and for the work on this PR. I like the direction, but I think we should adjust the structure before merging so that we establish a clean and maintainable contributor recognition system from the beginning.
1. Keep CONTRIBUTORS.md minimal
CONTRIBUTORS.md should not contain contributor names, categories, or the Hall of Fame itself.
It should only explain how people can contribute and point contributors to the Hall of Fame.
Add a single reference such as:
## Contributors Hall of Fame
See the Contributors Hall of Fame for contributors recognized for their contributions to QuTub Transpiler.
The actual list of contributors should live entirely in:
docs/CONTRIBUTORS_HALL_OF_FAME.md
2. Create the Hall of Fame under docs/
Create:
docs/CONTRIBUTORS_HALL_OF_FAME.md
This should be the actual recognition document.
It should contain:
Recognized contributors
Their contribution area
Their recognition level
A short description of their contribution
The date/period of recognition where appropriate
Do not duplicate the contributor list in CONTRIBUTORS.md.
3. Establish minimum recognition criteria
Before adding people to the Hall of Fame, we should define a clear minimum standard.
The Hall of Fame should not become a list of everyone who has opened a PR. We should recognize meaningful and sustained contributions.
Please introduce a simple contribution-credit system where different types of contributions can have different weights.
For example:
| Contribution | Credits |
|---|---|
| Major feature / subsystem | 10 |
| Significant bug fix | 5 |
| Meaningful optimization | 5 |
| Test infrastructure / substantial test coverage | 4 |
| Documentation improvement | 3 |
| Code review with meaningful technical impact | 2 |
| Meaningful issue investigation / bug report | 2 |
| Small code or documentation improvement | 1 |
| Research / technical contribution | 5 |
| Community / mentoring contribution | 3 |
These values are a starting point and can be adjusted if you think a better weighting makes sense.
The important part is that contribution impact should matter more than raw PR or commit count.
4. Define recognition levels
Please add clear thresholds so contributors have a visible path toward recognition.
For example:
First Contribution
First accepted contribution to the project.
Active Contributor
Minimum of 5 contribution credits and at least 2 meaningful contributions.
Distinguished Contributor
Minimum of 15 contribution credits with sustained meaningful involvement.
Hall of Fame
Minimum of 30 contribution credits representing substantial and sustained contribution to the project.
Project Champion
Minimum of 50 contribution credits, or exceptional long-term contribution, leadership, mentorship, or major technical impact.
These thresholds should be treated as recognition guidelines rather than an automatic entitlement. Maintainers should retain discretion to recognize exceptional contributions that do not fit neatly into the scoring system.
5. Add contribution recognition categories
The Hall of Fame should also recognize how someone contributed, rather than only how many contributions they made.
Suggested categories:
Code
Documentation
Testing
Research
Bug Fixing
Code Review
Performance
Architecture
Community and Mentoring
A contributor can have multiple recognition categories.
For example:
### @usernameRecognition: Distinguished Contributor
Areas: Code, Testing, Performance
Contribution: Improved the transpiler routing infrastructure, expanded test coverage, and contributed performance improvements.
Keep these names professional and avoid emoji-based badges so the system remains clean and maintainable.
6. Move the current first entry
The current @Ark12a entry should be moved out of CONTRIBUTORS.md and into the new:
docs/CONTRIBUTORS_HALL_OF_FAME.md
It can be recognized for establishing the Hall of Fame/documentation structure, assuming it meets the agreed recognition criteria.
7. README integration
The README should provide a direct link to the Hall of Fame so it is visible to people visiting the project.
The structure should ultimately be:
README.md
|
+--> CONTRIBUTORS.md
|
+--> Contributors Hall of Fame
|
+--> docs/CONTRIBUTORS_HALL_OF_FAME.md
There should be one source of truth for the actual contributor list: the Hall of Fame document.
Expected Result
After the changes, the repository should have this structure:
CONTRIBUTORS.md
docs/
CONTRIBUTORS_HALL_OF_FAME.md
README.md
CONTRIBUTORS.md = how to contribute + one link to the Hall of Fame.
docs/CONTRIBUTORS_HALL_OF_FAME.md = the actual contributors, recognition levels, contribution categories, and recognition criteria.
README.md = visible entry point/link to the Hall of Fame.
Please restructure the PR accordingly and request another review once these changes are pushed.
The overall idea is good, and I think this structure will give QuTub a much stronger and more sustainable contributor recognition system as the project grows.
Ark12a
left a comment
There was a problem hiding this comment.
@amir-hameed-mir Please check the updated version of the CONTRIBUTOS_HALL_OF_FAME.md file
|
@Ark12a Looks good to me , but i think we need to replace the name to guidelines for contributors hall of fame and then create Hall of fame markdown which would actually contain the names in a tabular form, you can open a new issue once this is merged and then do a PR |
Description
This PR addresses Issue #55 by establishing the new "Contributors Hall of Fame" within
CONTRIBUTORS.md. It creates a structured, highly maintainable format to celebrate community members who contribute through code, documentation, testing, and community support.Changes Included
@Ark12aunder Documentation Contributors for setting up this Hall of Fame.- [@username](link) — Description) to keep future additions consistent.CONTRIBUTORS.mdin theREADME.mdto ensure high visibility.Related Issue
Closes #55