Add Contributor Skill
This skill automates adding a new contributor to the Goravel documentation contributor lists in en/prologue/contributions.md and en/index.md.
Workflow
1. Input: GitHub Profile URL
The user provides a GitHub profile URL, e.g.:
https://github.com/hwbrzzl
2. Extract Username
From the URL, extract the username (e.g., hwbrzzl).
3. Fetch Avatar URL
Make a fetch request to the GitHub API to get the user's profile data:
- Endpoint:
https://api.github.com/users/{username} - Extract the
avatar_urlfield from the JSON response - The URL will be in the format:
https://avatars.githubusercontent.com/u/{user_id}?v=4
4. Generate HTML Snippet
Create an HTML anchor tag with the avatar image:
<a href="https://github.com/{username}" target="_blank"><img src="{avatar_url}" width="48" height="48"></a>
5. Add to Contribution Sections
Locate the appropriate sections:
en/prologue/contributions.md- Contributors section: Add to the Contributors
<div>block - Core Developers section: Add to the Core Developers
<div>block (if applicable) en/index.md- Contributors section: Add to the contributors avatar list under
## Contributors
Insert the HTML snippet as a new line in both files:
- In
en/prologue/contributions.md, insert before the closing</div>tag of the target list. - In
en/index.md, insert in the contributors avatar list before the closing</div>of the contributors block.
6. Update Documentation
Update both files and verify the contributor appears correctly in the rendered documentation.
Implementation Steps
- Request the GitHub profile URL from the user
- Extract the username from the URL
- Fetch user data from GitHub API to get the avatar URL
- Create the HTML contributor entry
- Insert into the appropriate section of
en/prologue/contributions.md - Insert into the
## Contributorslist inen/index.md - Confirm addition in both files
Example
Input: https://github.com/hwbrzzl
Extracted User ID from API: 108449432
Generated Snippet:
<a href="https://github.com/hwbrzzl" target="_blank"><img src="https://avatars.githubusercontent.com/u/108449432?v=4" width="48" height="48"></a>
Location in Files:
en/prologue/contributions.md: Added to Contributors section before</div>closing tagen/index.md: Added to Contributors section before the closing</div>
Source: goravel/docs — distributed by TomeVault.