Skip to content

Commit 1322aa2

Browse files
committed
feat(eng): add contributor reporting and management scripts
- Add eng/README.md documenting maintainer utilities - Add eng/contributor-report.mjs for generating contributor reports - Add eng/add-missing-contributors.mjs for automating contributor additions - Add eng/utils/graceful-shutdown.mjs for script lifecycle management - Update eng/update-readme.mjs with minor fixes - Update package.json with new contributor scripts Generated-by: GitHub Copilot <[email protected]> Signed-off-by: Ashley Childress <[email protected]>
1 parent d929b71 commit 1322aa2

File tree

10 files changed

+2353
-518
lines changed

10 files changed

+2353
-518
lines changed

.all-contributorsrc

Lines changed: 1113 additions & 401 deletions
Large diffs are not rendered by default.

.github/workflows/contributors.yml

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,52 @@ on:
88
jobs:
99
contributors:
1010
runs-on: ubuntu-latest
11+
timeout-minutes: 12
1112
permissions:
1213
contents: write
1314
pull-requests: write
1415
steps:
1516
- name: Checkout
16-
uses: actions/checkout@v5
17+
uses: actions/checkout@v6
1718
with:
18-
fetch-depth: 0
19+
fetch-depth: 0 # Required: add-missing-contributors.js needs full git history
20+
21+
- name: Extract Node version from package.json
22+
id: node-version
23+
run: |
24+
NODE_VERSION=$(jq -r '.engines.node // "22.x"' package.json)
25+
echo "version=${NODE_VERSION}" >> "$GITHUB_OUTPUT"
1926
2027
- name: Setup Node.js
21-
uses: actions/setup-node@v4
28+
uses: actions/setup-node@v6
2229
with:
23-
node-version: "20"
30+
node-version: ${{ steps.node-version.outputs.version }}
2431

2532
- name: Install dependencies
26-
run: npm install
33+
run: npm ci
2734

28-
- name: Update contributors
29-
run: npm run contributors:check
35+
- name: Check and report contributors
36+
run: |
37+
CHECK_OUTPUT=$(npm run contributors:check 2>&1)
38+
echo "$CHECK_OUTPUT"
39+
40+
if echo "$CHECK_OUTPUT" | grep -q "Missing contributors"; then
41+
echo "Missing contributors detected, generating report..."
42+
mkdir -p reports
43+
npm run contributors:report
44+
45+
if [ -f reports/contributor-report.md ]; then
46+
cat reports/contributor-report.md >> $GITHUB_STEP_SUMMARY
47+
fi
48+
else
49+
echo "No missing contributors found"
50+
fi
3051
env:
3152
PRIVATE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
53+
continue-on-error: true
3254

3355
- name: Regenerate README
34-
run: |
35-
npm install
36-
npm start
56+
run: npm start
3757

3858
- name: Check for changes
3959
id: verify-changed-files

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
node_modules
22
*.orig
33
Copilot-Processing.md
4+
reports/
45

56
# macOS system files
67
.DS_Store

CONTRIBUTING.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,8 @@ For full example of usage checkout edge-ai tasks collection:
191191
- A brief description of what your instruction/prompt does
192192
- Any relevant context or usage notes
193193

194-
**Note**: Once your contribution is merged, you'll automatically be added to our [Contributors](./README.md#contributors-) section! We use [all-contributors](https://github.com/all-contributors/all-contributors) to recognize all types of contributions to the project.
194+
> [!NOTE]
195+
> We use [all-contributors](https://github.com/all-contributors/all-contributors) to recognize all types of contributions to the project. Jump to [Contributors Recognition](#contributor-recognition) to learn more!
195196

196197
## What We Accept
197198

@@ -225,21 +226,33 @@ To maintain a safe, responsible, and constructive community, we will **not accep
225226
- **Write clearly**: Use simple, direct language
226227
- **Promote best practices**: Encourage secure, maintainable, and ethical development practices
227228

228-
## Contributors Recognition
229+
## Contributor Recognition
229230

230-
This project uses [all-contributors](https://github.com/all-contributors/all-contributors) to recognize contributors. When you make a contribution, you'll automatically be recognized in our contributors list!
231+
We use [all-contributors](https://github.com/all-contributors/all-contributors) to recognize **all types of contributions** to this project.
231232

232-
We welcome contributions of all types, including:
233+
To add yourself, leave a comment on a relevant issue or pull request using your GitHub username and the appropriate contribution type(s):
233234

234-
- 📝 Documentation improvements
235-
- 💻 Code contributions
236-
- 🐛 Bug reports and fixes
237-
- 🎨 Design improvements
238-
- 💡 Ideas and suggestions
239-
- 🤔 Answering questions
240-
- 📢 Promoting the project
235+
```markdown
236+
@all-contributors add @username for contributionType1, contributionType2
237+
```
238+
239+
The contributors list is updated automatically every Sunday at **3:00 AM UTC**. When the next run completes, your name will appear in the [README Contributors](./README.md#contributors-) section.
240+
241+
### Contribution Types
242+
243+
We welcome many kinds of contributions, including the custom categories below:
244+
245+
| Category | Description | Emoji |
246+
| --- | --- | :---: |
247+
| **Instructions** | Custom instruction sets that guide GitHub Copilot behavior | 🧭 |
248+
| **Prompts** | Reusable or one-off prompts for GitHub Copilot | ⌨️ |
249+
| **Agents (Chat Modes)** | Defined Copilot roles or personalities | 🎭 |
250+
| **Collections** | Curated bundles of related prompts, agents, or instructions | 🎁 |
251+
252+
In addition, all standard contribution types supported by [All Contributors](https://allcontributors.org/emoji-key/) are recognized.
253+
254+
> Every contribution matters. Thanks for helping improve this resource for the GitHub Copilot community.
241255

242-
Your contributions help make this resource better for the entire GitHub Copilot community!
243256

244257
## Code of Conduct
245258

0 commit comments

Comments
 (0)