Skip to content

Commit c7a00cc

Browse files
feat: add good-first-issue template and contributor starter checklist (issue #7546)\n\nProvide a small onboarding template and starter checklist to make it easier for new contributors to open focused PRs.\n\nCo-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 58a74f9 commit c7a00cc

2 files changed

Lines changed: 76 additions & 0 deletions

File tree

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: "Good first issue"
2+
about: "A small, self-contained task suitable for new contributors. Follow the steps and submit a small PR."
3+
title: "Good first issue: [short description]"
4+
labels: ["good first issue", "help wanted"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for helping! This template describes a small task that is suitable for a new contributor.
11+
- type: input
12+
id: description
13+
attributes:
14+
label: "What needs to be done?"
15+
description: "Provide a concise description of the change required and why."
16+
placeholder: "Add examples to README for X; implement unit tests for Y; fix typo in Z."
17+
required: true
18+
- type: input
19+
id: acceptance_criteria
20+
attributes:
21+
label: "Acceptance criteria"
22+
description: "List the checks that will show the task is complete (tests, example run, docs updated)."
23+
placeholder: "1) README has code example; 2) Tests pass on CI"
24+
required: true
25+
- type: textarea
26+
id: steps
27+
attributes:
28+
label: "Suggested steps"
29+
description: "Optional step-by-step guidance for contributors."
30+
placeholder: "1) Fork repo; 2) Create branch; 3) Make changes; 4) Run tests; 5) Open PR."
31+
required: false
32+
- type: dropdown
33+
id: difficulty
34+
attributes:
35+
label: "Difficulty"
36+
options:
37+
- "low"
38+
- "medium"
39+
- "high"
40+
description: "Estimate the difficulty for this task."
41+
required: true
42+
- type: input
43+
id: related_issues
44+
attributes:
45+
label: "Related issues or references"
46+
required: false

CONTRIBUTOR_STARTER.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Contributor starter template
2+
3+
This small template provides minimal files and guidance that can be used to initialize a new repository or provide a starter PR for an empty project.
4+
5+
Suggested files to add in a starter PR:
6+
- README.md: Short project description, purpose, quick start, and how to contribute.
7+
- CONTRIBUTING.md: Minimal contribution flow (fork -> branch -> PR), coding style notes, testing instructions.
8+
- .github/ISSUE_TEMPLATE/good_first_issue.yml: Template for small tasks for new contributors (already added here).
9+
- LICENSE: e.g., MIT or Apache-2.0.
10+
- .github/workflows/build.yml: Basic CI to run tests on push/PR (optional).
11+
12+
Quick README example:
13+
14+
# ProjectName
15+
16+
Short one-line description.
17+
18+
## Getting started
19+
20+
1. Fork the repository
21+
2. Build with: mvn -q -DskipTests package
22+
3. Run tests: mvn -q test
23+
24+
## Contributing
25+
26+
See CONTRIBUTING.md and look for issues labeled `good first issue`.
27+
28+
---
29+
30+
Use this file as a checklist when opening an initial "starter" PR for a new repo. Keep the PR small and focused on onboarding (docs + ci), not large feature work.

0 commit comments

Comments
 (0)