Skip to content

Commit fe1601d

Browse files
imathimath
committed
Add task templates using the GH Issue template beta feature
1 parent 714d9d7 commit fe1601d

File tree

5 files changed

+144
-1
lines changed

5 files changed

+144
-1
lines changed

‎.github/ISSUE_TEMPLATE/1-migrate-task.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Migrate task
2+
description: File a BP Codex to `buddypress/docs` migrate task.
3+
title: "[Migrate]: "
4+
projects: ["buddypress/2"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this migrate task!
10+
- type: input
11+
id: codexLink
12+
attributes:
13+
label: Link to the existing BP Codex page.
14+
description: This will be useful to get the content to update and edit the Codex page with a link to the `buddypress/docs` Markdown file.
15+
placeholder: https://codex.buddypress.org/?p=0
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: what-needs-to-be-done
20+
attributes:
21+
label: What needs to be done?
22+
description: Do we have to simply migrate the content, update some texts, refresh the screenshots, etc..?
23+
placeholder: This is what needs to be done!
24+
value: "Ready to be migrated!"
25+
validations:
26+
required: true
27+
- type: dropdown
28+
id: handbook
29+
attributes:
30+
label: Handbook to migrate the page in
31+
description: Select the temporary GH Handbook you think the page should be migrated to.
32+
options:
33+
- buddypress/docs/user
34+
- buddypress/docs/developer
35+
- buddypress/docs/contributor
36+
default: 0
37+
validations:
38+
required: true
39+
- type: checkboxes
40+
id: taskTracker
41+
attributes:
42+
label: Tasks to accomplish
43+
description: This is a reminder about steps needed for this Documentation resource to be migrated.
44+
options:
45+
- label: This task has been added to the "Todo" panel of the Documentation project.
46+
required: false
47+
- label: The corresponding line of the `data/README.md` Pages list has been marked as "Migrate issue/task created".
48+
required: false
49+
- label: A PR has been submitted to the BuddyPress GH repository, it has been linked to this issue/task & the task was moved to the "In progress" panel of the Documentation project.
50+
required: false
51+
- label: The PR has been converted to a SVN patch and committed to the BuddyPress SVN repository & the task was moved to the "Done" panel of the Documentation project.
52+
required: false

‎.github/ISSUE_TEMPLATE/2-add-task.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Add task
2+
description: File a task to create a new `buddypress/docs` Documentation resource.
3+
title: "[Add]: "
4+
projects: ["buddypress/2"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this task to add a new Documentation page to!
10+
- type: textarea
11+
id: what-needs-to-be-done
12+
attributes:
13+
label: What needs to be done?
14+
description: What this new documentation needs to explain and how?
15+
placeholder: This is what needs to be done!
16+
value: "Explain how this should be used!"
17+
validations:
18+
required: true
19+
- type: dropdown
20+
id: handbook
21+
attributes:
22+
label: Handbook to add the page in
23+
description: Select the temporary GH Handbook you think the page should be added to.
24+
options:
25+
- buddypress/docs/user
26+
- buddypress/docs/developer
27+
- buddypress/docs/contributor
28+
default: 0
29+
validations:
30+
required: true
31+
- type: checkboxes
32+
id: taskTracker
33+
attributes:
34+
label: Tasks to accomplish
35+
description: This is a reminder about steps needed for this Documentation resource to be created.
36+
options:
37+
- label: This task has been added to the "Todo" panel of the Documentation project.
38+
required: false
39+
- label: A PR has been submitted to the BuddyPress GH repository, it has been linked to this issue/task & the task was moved to the "In progress" panel of the Documentation project.
40+
required: false
41+
- label: The PR has been converted to a SVN patch and committed to the BuddyPress SVN repository & the task was moved to the "Done" panel of the Documentation project.
42+
required: false

‎.github/ISSUE_TEMPLATE/3-ignore-task.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Ignore task
2+
description: File a task to ignore a BP Codex page migration.
3+
title: "[Ignore]: "
4+
projects: ["buddypress/2"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this "ignore" task!
10+
- type: input
11+
id: codexLink
12+
attributes:
13+
label: Link to the existing BP Codex page.
14+
description: This will not be so useful but it's always good to have details!
15+
placeholder: https://codex.buddypress.org/?p=0
16+
validations:
17+
required: false
18+
- type: textarea
19+
id: why-ignoring
20+
attributes:
21+
label: Why should we ignore this page?
22+
description: Explain why you think we should not migrate this page to one of the `buddypress/docs` Handbooks?
23+
placeholder: This is where you write the why!
24+
value: "Because BuddyPress is not using this anymore!"
25+
validations:
26+
required: true
27+
- type: checkboxes
28+
id: taskTracker
29+
attributes:
30+
label: Tasks to accomplish
31+
description: This is a reminder about steps needed for this Documentation resource to be ignored.
32+
options:
33+
- label: This task has been added to the "Todo" panel of the Documentation project.
34+
required: false
35+
- label: One of the BuddyPress Core committer reviewed it and agreed to ignore this Codex page.
36+
required: false
37+
- label: The task was moved to the "Done" panel of the Documentation project.
38+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: BuddyPress Codex
4+
url: https://codex.buddypress.org/
5+
about: The wiki flavoured & legacy BuddyPress documentation resources to migrate.
6+
- name: buddypress/docs
7+
url: https://github.com/buddypress/buddypress/tree/master/docs
8+
about: The temporary and GH browsable Documentation resources migrated from the BP Codex

‎data/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Codex pages
22

3+
- ♻️ Migrate issue/task created.
4+
- 🛑 Ignore issue/task created.
5+
36
Page ID | Title | Link | Published on
47
--- | --- | --- | ---
58
15958 | Activity Embeds | [https://codex.buddypress.org/?p=15958](https://codex.buddypress.org/?p=15958) | 2016/06/15
@@ -65,7 +68,7 @@ Page ID | Title | Link | Published on
6568
6533 | — — Preventing Spammer Registration | [https://codex.buddypress.org/?p=6533](https://codex.buddypress.org/?p=6533) | 2013/10/31
6669
4408 | — — Migrating from old forums to bbPress 2.2+ | [https://codex.buddypress.org/?p=4408](https://codex.buddypress.org/?p=4408) | 2012/11/22
6770
8542 | Administrator Guide | [https://codex.buddypress.org/?p=8542](https://codex.buddypress.org/?p=8542) | 2014/11/09
68-
17466 | — Alternative Registration Workflows | [https://codex.buddypress.org/?p=17466](https://codex.buddypress.org/?p=17466) | 2021/12/15
71+
♻️ 17466 | — Alternative Registration Workflows | [https://codex.buddypress.org/?p=17466](https://codex.buddypress.org/?p=17466) | 2021/12/15
6972
5680 | — Members | [https://codex.buddypress.org/?p=5680](https://codex.buddypress.org/?p=5680) | 2013/05/07
7073
5647 | — Messages | [https://codex.buddypress.org/?p=5647](https://codex.buddypress.org/?p=5647) | 2013/05/07
7174
7846 | — Manage User Signups | [https://codex.buddypress.org/?p=7846](https://codex.buddypress.org/?p=7846) | 2014/04/16

0 commit comments

Comments
 (0)