mirror of
https://github.com/0x5t4l1n/Keylogger.git
synced 2026-05-26 19:36:31 +00:00
Merge pull request #18 from Stalin-143/copilot/add-contributor-hall-of-fame
Add automated contributors hall of fame with profile photos
This commit is contained in:
@@ -0,0 +1,39 @@
|
|||||||
|
{
|
||||||
|
"projectName": "Keylogger",
|
||||||
|
"projectOwner": "Stalin-143",
|
||||||
|
"repoType": "github",
|
||||||
|
"repoHost": "https://github.com",
|
||||||
|
"files": [
|
||||||
|
"CONTRIBUTORS.md"
|
||||||
|
],
|
||||||
|
"imageSize": 100,
|
||||||
|
"commit": false,
|
||||||
|
"commitConvention": "none",
|
||||||
|
"contributors": [
|
||||||
|
{
|
||||||
|
"login": "Stalin-143",
|
||||||
|
"name": "Stalin-143",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/161853795?v=4",
|
||||||
|
"profile": "https://github.com/Stalin-143",
|
||||||
|
"contributions": [
|
||||||
|
"code",
|
||||||
|
"doc",
|
||||||
|
"infra",
|
||||||
|
"maintenance"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "Always-Amulya7",
|
||||||
|
"name": "Always-Amulya7",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/Always-Amulya7?v=4",
|
||||||
|
"profile": "https://github.com/Always-Amulya7",
|
||||||
|
"contributions": [
|
||||||
|
"code",
|
||||||
|
"ideas"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"contributorsPerLine": 7,
|
||||||
|
"skipCi": true,
|
||||||
|
"badgeTemplate": "[](#contributors)"
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
name: Add Contributors
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
types: [closed]
|
||||||
|
issues:
|
||||||
|
types: [closed]
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
workflow_dispatch: # Allow manual triggering
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
add-contributors:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.event_name == 'workflow_dispatch' || github.event_name == 'push' || (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true)
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
ref: main # Always checkout main branch for security
|
||||||
|
|
||||||
|
- name: Update contributors
|
||||||
|
uses: akhilmhdh/contributors-readme-action@v2.3.6
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
image_size: 100
|
||||||
|
columns_per_row: 6
|
||||||
|
collaborators: 'all'
|
||||||
|
committer_username: 'github-actions[bot]'
|
||||||
|
committer_email: '41898282+github-actions[bot]@users.noreply.github.com'
|
||||||
|
commit_message: 'docs: update contributors list'
|
||||||
|
readme_path: 'CONTRIBUTORS.md'
|
||||||
+7
-2
@@ -1,6 +1,11 @@
|
|||||||
# 👥 Contributors
|
# 👥 Contributors Hall of Fame
|
||||||
|
|
||||||
Thank you to everyone who has contributed to this project!
|
Thank you to everyone who has contributed to this project! 🎉
|
||||||
|
|
||||||
|
## 🏆 Contributors Gallery
|
||||||
|
|
||||||
|
<!-- readme: collaborators,contributors -start -->
|
||||||
|
<!-- readme: collaborators,contributors -end -->
|
||||||
|
|
||||||
## Project Maintainer
|
## Project Maintainer
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,83 @@
|
|||||||
|
# Contributors Automation Guide
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This repository uses an automated system to maintain a Contributors Hall of Fame with GitHub profile photos. When anyone contributes to the project through merged pull requests, they will be automatically added to the [CONTRIBUTORS.md](CONTRIBUTORS.md) file.
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
1. **Automatic Detection**: When a pull request is merged to the main branch, the GitHub Actions workflow automatically detects all contributors.
|
||||||
|
|
||||||
|
2. **Profile Photos**: The system fetches GitHub profile photos for each contributor and displays them in the Contributors Hall of Fame.
|
||||||
|
|
||||||
|
3. **Automatic Updates**: The CONTRIBUTORS.md file is automatically updated with new contributors, maintaining a beautiful gallery of everyone who has helped the project.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- ✨ Automatic detection of new contributors
|
||||||
|
- 📸 GitHub profile photos displayed in the hall of fame
|
||||||
|
- 🔄 Automatic updates on every merged PR
|
||||||
|
- 👥 Recognition for all types of contributions (code, documentation, ideas, etc.)
|
||||||
|
|
||||||
|
## The Contributors Workflow
|
||||||
|
|
||||||
|
The automation is powered by a GitHub Actions workflow located at `.github/workflows/contributors.yml`. This workflow:
|
||||||
|
|
||||||
|
1. Triggers when:
|
||||||
|
- A pull request is merged to main
|
||||||
|
- Code is pushed to the main branch
|
||||||
|
- Manually triggered via workflow_dispatch
|
||||||
|
|
||||||
|
2. Automatically:
|
||||||
|
- Fetches all contributors from the repository
|
||||||
|
- Updates the CONTRIBUTORS.md file with profile photos
|
||||||
|
- Commits the changes back to the repository
|
||||||
|
|
||||||
|
## Manual Triggering
|
||||||
|
|
||||||
|
Repository maintainers can manually trigger the contributors update by:
|
||||||
|
1. Going to Actions tab in GitHub
|
||||||
|
2. Selecting "Add Contributors" workflow
|
||||||
|
3. Clicking "Run workflow"
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
The contributors system is configured in:
|
||||||
|
- `.github/workflows/contributors.yml` - The automation workflow
|
||||||
|
- `.all-contributorsrc` - Configuration for the all-contributors system
|
||||||
|
|
||||||
|
### Customization Options
|
||||||
|
|
||||||
|
You can customize the appearance by editing `.github/workflows/contributors.yml`:
|
||||||
|
- `image_size`: Size of profile photos (default: 100px)
|
||||||
|
- `columns_per_row`: Number of contributors per row (default: 6)
|
||||||
|
|
||||||
|
## For Contributors
|
||||||
|
|
||||||
|
When you contribute to this project:
|
||||||
|
1. Your GitHub profile will automatically appear in the Contributors Hall of Fame
|
||||||
|
2. Your profile photo will be displayed
|
||||||
|
3. You'll be recognized for your contributions
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- GitHub Actions must be enabled for the repository
|
||||||
|
- The workflow requires `contents: write` permission to update files
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
If contributors are not being added automatically:
|
||||||
|
1. Check that GitHub Actions is enabled
|
||||||
|
2. Verify the workflow has necessary permissions
|
||||||
|
3. Ensure the main branch name matches the configuration
|
||||||
|
4. Manually trigger the workflow to force an update
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
|
||||||
|
This automation uses:
|
||||||
|
- [contributors-readme-action](https://github.com/akhilmhdh/contributors-readme-action) by akhilmhdh
|
||||||
|
- GitHub Actions for automation
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
For questions about the contributors system, please open an issue on GitHub.
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
# Keylogger :)
|
# Keylogger :)
|
||||||
|
|
||||||
|
[](https://github.com/Stalin-143/Keylogger/graphs/contributors)
|
||||||
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -138,8 +140,11 @@ This project is intended for **educational purposes** only. Unauthorized use of
|
|||||||
- Related Articles on Ethical Hacking and Cybersecurity
|
- Related Articles on Ethical Hacking and Cybersecurity
|
||||||
|
|
||||||
## Contributions
|
## Contributions
|
||||||
|
|
||||||
Contributions are welcome! Please make sure to follow ethical guidelines and legal standards when contributing to this project.
|
Contributions are welcome! Please make sure to follow ethical guidelines and legal standards when contributing to this project.
|
||||||
|
|
||||||
|
See our [Contributors Hall of Fame](CONTRIBUTORS.md) to view all the amazing people who have contributed to this project! ✨
|
||||||
|
|
||||||
## 📜 License
|
## 📜 License
|
||||||
|
|
||||||
This project is licensed under the [License](LICENSE)
|
This project is licensed under the [License](LICENSE)
|
||||||
|
|||||||
Reference in New Issue
Block a user