Skip to content

Commit 363486e

Browse files
dave2wavedave2wave
authored
Merge pull request #635 from apache/multiple-pr-templates
Add multiple PR templates for different contribution types
2 parents 9e8e27c + 072ad18 commit 363486e

3 files changed

Lines changed: 82 additions & 6 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md renamed to .github/PULL_REQUEST_TEMPLATE/action_approval.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
119
# Request for adding a new GitHub Action to the allow list
220

321
## Overview
422

5-
<!-- Please describe the proposed action; what it does and why this is needed.
6-
It will help if you can tell us which project is interested in this action
23+
<!-- Please describe the proposed action; what it does and why this is needed.
24+
It will help if you can tell us which project is interested in this action
725
and why.
826
-->
927

10-
**Name of action:**
28+
**Name of action:**
1129

1230
**URL of action:**
1331

@@ -16,13 +34,13 @@
1634

1735
## Permissions
1836

19-
<!-- Describe the permissions required and whether these permissions can have
20-
security or provenance implications such as write access to code or read
37+
<!-- Describe the permissions required and whether these permissions can have
38+
security or provenance implications such as write access to code or read
2139
access to credentials. -->
2240

2341
## Related Actions
2442

25-
<!-- If this action is similar to an existing, allowed action (please do check!),
43+
<!-- If this action is similar to an existing, allowed action (please do check!),
2644
let us know how this one differs and is a better option for your use case.
2745
-->
2846

‎.github/PULL_REQUEST_TEMPLATE/code_change.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
# Code change
20+
21+
## Summary
22+
23+
<!-- Describe what this PR changes and why. -->
24+
25+
## Type of change
26+
27+
<!-- Check all that apply. -->
28+
29+
- [ ] New utility or action
30+
- [ ] Bug fix
31+
- [ ] Enhancement to existing code
32+
- [ ] Workflow or CI change
33+
- [ ] Documentation update
34+
- [ ] Other
35+
36+
## Testing
37+
38+
<!-- How was this tested? Include any relevant details. -->

‎AGENTS.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,23 @@ Generated-by: <Agent information>
4040
Always use `--web` when creating PRs (e.g. `gh pr create --web ...`). This opens the PR in the
4141
browser and gives the author a chance to review the title, description, and diff before submitting.
4242
Do not create PRs directly from the CLI without `--web`.
43+
44+
### PR templates
45+
46+
This repository uses multiple PR templates located in `.github/PULL_REQUEST_TEMPLATE/`:
47+
48+
- **`action_approval.md`** — Use for requests to add a new GitHub Action to the allow list. Includes
49+
fields for the action name, URL, pinned version hash, permissions, related actions, and a review
50+
checklist.
51+
- **`code_change.md`** — Use for all other changes: new utilities, bug fixes, enhancements, workflow
52+
or CI changes, and documentation updates.
53+
54+
When creating a PR via `gh pr create --web`, GitHub will present a template chooser. Select the
55+
template that matches the type of change. When opening a PR URL directly, you can append
56+
`&template=action_approval.md` or `&template=code_change.md` to pre-fill the appropriate template.
57+
58+
## License headers
59+
60+
All files must include the Apache License 2.0 header where the file format supports it. Use the
61+
appropriate comment syntax for the file type (e.g., `<!-- -->` for Markdown/HTML, `#` for YAML/Python,
62+
`//` for JavaScript/Go). See existing files in the repository for examples of the correct format.

0 commit comments

Comments
 (0)