Skip to content

Commit fa2f40c

Browse files
authored
Add split pull request templates (#1919)
Add split templates for all the five paths our pull requests take. This makes it possible to use a parameter such as `?template=archive.md` to display a more specific template than the base one (which remains the default). These templates can be used in the future to facilitate easier pull request workflows. Initially, the text is mostly unchanged from the base template, except where the information was irrelevant. Bug #535 Signed-off-by: Michał Górny <mgorny@quansight.com>
1 parent f8fef00 commit fa2f40c

File tree

6 files changed

+146
-64
lines changed

6 files changed

+146
-64
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,9 @@
1-
<!--
2-
Hi!
1+
## Template selection
32

4-
Thank you for making an admin request on this repo. We strive to make a decision
5-
on these requests within 24 hours.
3+
Please go to the "Preview" tab and select the appropriate template:
64

7-
Please use the text below to add context about this PR, especially if:
8-
- You want to mark packages as broken
9-
- You want to archive a feedstock
10-
- You want to request access to opt-in CI resources
11-
12-
Cheers and thank you for contributing to conda-forge!
13-
-->
14-
15-
## Guidelines for marking packages as broken:
16-
17-
* We prefer to patch the repo data (see [here](https://github.com/conda-forge/conda-forge-repodata-patches-feedstock))
18-
instead of marking packages as broken. This alternative workflow makes environments more reproducible.
19-
* Packages with requirements/metadata that are too strict but otherwise work are
20-
not technically broken and should not be marked as such.
21-
* Packages with missing metadata can be marked as broken on a temporary basis
22-
but should be patched in the repo data and be marked unbroken later.
23-
* In some cases where the number of users of a package is small or it is used by
24-
the maintainers only, we can allow packages to be marked broken more liberally.
25-
* You can use `pixi run find-name {matchspec}` to get a list of filenames matching given spec.
26-
* We (`conda-forge/core`) try to make a decision on these requests within 24 hours.
27-
28-
What will happen when a package is marked broken?
29-
30-
* Our bots will add the `broken` label to the package. The `main` label will remain on the package and this is normal.
31-
* Our bots will rebuild our repodata patches to remove this package from the repodata.
32-
* In a few hours after the `anaconda.org` CDN picks up the new patches, you will no longer be able to install the package from the `main` channel.
33-
34-
35-
## Checklist:
36-
37-
* [ ] I want to mark a package as broken (or not broken):
38-
* [ ] Added a description of the problem with the package in the PR description.
39-
* [ ] Pinged the team for the package for their input.
40-
41-
* [ ] I want to archive a feedstock:
42-
* [ ] Pinged the team for that feedstock for their input.
43-
* [ ] Make sure you have opened an issue on the feedstock explaining why it was archived.
44-
* [ ] Linked that issue in this PR description.
45-
* [ ] Added links to any other relevant issues/PRs in the PR description.
46-
47-
* [ ] I want to request (or revoke) access to an opt-in CI resource:
48-
* [ ] Pinged the relevant feedstock team(s)
49-
* [ ] Added a small description explaining why access is needed
50-
51-
* [ ] I want to copy an artifact following [CFEP-3](https://github.com/conda-forge/cfep/blob/main/cfep-03.md):
52-
* [ ] Pinged the relevant feedstock team(s)
53-
* [ ] Added a reference to the original PR
54-
* [ ] Posted a link to the conda artifacts
55-
* [ ] Posted a link to the build logs
56-
57-
* [ ] I want to add a package output to a feedstock:
58-
* [ ] Pinged the relevant feedstock team(s)
59-
* [ ] Added a small description of why the output is being added.
60-
61-
<!--
62-
For example if you are trying to mark a `foo` conda package as broken.
63-
64-
ping @conda-forge/foo
65-
66-
-->
5+
* [I want to mark a package as broken (or not broken)](?expand=1&template=broken.md)
6+
* [I want to archive a feedstock](?expand=1&template=archive.md)
7+
* [I want to request (or revoke) access to an opt-in CI resource](?expand=1&template=ci-resource.md)
8+
* [I want to copy an artifact following CFEP-3](?expand=1&template=cfep-3.md)
9+
* [I want to add a package output to a feedstock](?expand=1&template=add-feedstock-output.md)
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--
2+
Hi!
3+
4+
Thank you for making an admin request on this repo. We strive to make a decision
5+
on these requests within 24 hours.
6+
7+
Please use the text below to add context about this PR.
8+
9+
Cheers and thank you for contributing to conda-forge!
10+
-->
11+
12+
## Checklist:
13+
14+
* [x] I want to add a package output to a feedstock:
15+
* [ ] Pinged the relevant feedstock team(s)
16+
* [ ] Added a small description of why the output is being added.
17+
18+
<!--
19+
For example if you are trying to add an output to 'foo' feedstock.
20+
21+
ping @conda-forge/foo
22+
23+
-->
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
Hi!
3+
4+
Thank you for making an admin request on this repo. We strive to make a decision
5+
on these requests within 24 hours.
6+
7+
Please use the text below to add context about this PR.
8+
9+
Cheers and thank you for contributing to conda-forge!
10+
-->
11+
12+
## Checklist:
13+
14+
* [x] I want to archive a feedstock:
15+
* [ ] Pinged the team for that feedstock for their input.
16+
* [ ] Make sure you have opened an issue on the feedstock explaining why it was archived.
17+
* [ ] Linked that issue in this PR description.
18+
* [ ] Added links to any other relevant issues/PRs in the PR description.
19+
20+
<!--
21+
For example if you are trying to archive a `foo` feedstock.
22+
23+
ping @conda-forge/foo
24+
25+
-->
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!--
2+
Hi!
3+
4+
Thank you for making an admin request on this repo. We strive to make a decision
5+
on these requests within 24 hours.
6+
7+
Please use the text below to add context about this PR.
8+
9+
Cheers and thank you for contributing to conda-forge!
10+
-->
11+
12+
## Guidelines for marking packages as broken:
13+
14+
* We prefer to patch the repo data (see [here](https://github.com/conda-forge/conda-forge-repodata-patches-feedstock))
15+
instead of marking packages as broken. This alternative workflow makes environments more reproducible.
16+
* Packages with requirements/metadata that are too strict but otherwise work are
17+
not technically broken and should not be marked as such.
18+
* Packages with missing metadata can be marked as broken on a temporary basis
19+
but should be patched in the repo data and be marked unbroken later.
20+
* In some cases where the number of users of a package is small or it is used by
21+
the maintainers only, we can allow packages to be marked broken more liberally.
22+
* You can use `pixi run find-name {matchspec}` to get a list of filenames matching given spec.
23+
* We (`conda-forge/core`) try to make a decision on these requests within 24 hours.
24+
25+
What will happen when a package is marked broken?
26+
27+
* Our bots will add the `broken` label to the package. The `main` label will remain on the package and this is normal.
28+
* Our bots will rebuild our repodata patches to remove this package from the repodata.
29+
* In a few hours after the `anaconda.org` CDN picks up the new patches, you will no longer be able to install the package from the `main` channel.
30+
31+
32+
## Checklist:
33+
34+
* [x] I want to mark a package as broken (or not broken):
35+
* [ ] Added a description of the problem with the package in the PR description.
36+
* [ ] Pinged the team for the package for their input.
37+
38+
<!--
39+
For example if you are trying to mark a `foo` conda package as broken.
40+
41+
ping @conda-forge/foo
42+
43+
-->
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
Hi!
3+
4+
Thank you for making an admin request on this repo. We strive to make a decision
5+
on these requests within 24 hours.
6+
7+
Please use the text below to add context about this PR.
8+
9+
Cheers and thank you for contributing to conda-forge!
10+
-->
11+
12+
## Checklist:
13+
14+
* [x] I want to copy an artifact following [CFEP-3](https://github.com/conda-forge/cfep/blob/main/cfep-03.md):
15+
* [ ] Pinged the relevant feedstock team(s)
16+
* [ ] Added a reference to the original PR
17+
* [ ] Posted a link to the conda artifacts
18+
* [ ] Posted a link to the build logs
19+
20+
<!--
21+
For example if you are trying to copy artifacts for `foo` feedstock.
22+
23+
ping @conda-forge/foo
24+
25+
-->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--
2+
Hi!
3+
4+
Thank you for making an admin request on this repo. We strive to make a decision
5+
on these requests within 24 hours.
6+
7+
Please use the text below to add context about this PR.
8+
9+
Cheers and thank you for contributing to conda-forge!
10+
-->
11+
12+
## Checklist:
13+
14+
* [x] I want to request (or revoke) access to an opt-in CI resource:
15+
* [ ] Pinged the relevant feedstock team(s)
16+
* [ ] Added a small description explaining why access is needed
17+
18+
<!--
19+
For example if you are trying to request access for the `foo` feedstock.
20+
21+
ping @conda-forge/foo
22+
23+
-->

0 commit comments

Comments
 (0)