Skip to content

Commit cacb108

Browse files
egekorkanegekorkan
authored
Merge pull request #47 from w3c/egekorkan-patch-3
Issue Template for Binding Transitions
2 parents 5107141 + b0cd4f8 commit cacb108

File tree

4 files changed

+256
-0
lines changed

4 files changed

+256
-0
lines changed

‎.github/ISSUE_TEMPLATE/binding_submission.yaml‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: New Binding Submission
2+
description: |
3+
Use this template to submit a new binding to the registry, going to the initial state
4+
labels: ["new-binding"]
5+
title: Provide the name of the Binding, e.g. "Web of Things (WoT) HTTP Binding
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
> [!Note]
11+
Thank you for submitting a new binding. The fields in this template fill the entry
12+
format requirements set at https://w3c.github.io/wot-binding-registry/#entry-format.
13+
The binding document itself should have the content required at
14+
https://w3c.github.io/wot-binding-registry/#submission-requirements
15+
- type: markdown
16+
attributes:
17+
value: |
18+
> [!Note]
19+
Please make sure to comply with our Code of Conduct (https://www.w3.org/policies/code-of-conduct/).
20+
It defines expected and unacceptable behaviors and promotes high standards of professional practice.
21+
The custodian is encouraged to apply necessary measures when necessary.
22+
- type: input
23+
id: name
24+
attributes:
25+
label: Name of the Binding
26+
description: |
27+
Examples: Web of Things (WoT) HTTP Binding, Web of Things (WoT) CoAP Binding
28+
validations:
29+
required: true
30+
- type: input
31+
id: link
32+
attributes:
33+
label: Link to the binding document
34+
description: |
35+
Stable link whose content cannot change (e.g., a date, version number, etc.),
36+
which can be managed by another entity than the custodian.
37+
Examples: `https://www.w3.org/TR/wot/binding-templates/http-20240726/index.html`
38+
validations:
39+
required: true
40+
- type: input
41+
id: prefix
42+
attributes:
43+
label: Binding Prefix
44+
description: |
45+
Examples: `htv`, `modv`, `cov`
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: identification
50+
attributes:
51+
label: Binding Identification
52+
description: |
53+
URI Scheme or other TD terms reserved for this binding, each provided as a new line.
54+
Examples: "subprotocol":"sse", "href":"http://example.com", "contentType":"application/json"
55+
validations:
56+
required: true
57+
- type: checkboxes
58+
id: td-version
59+
attributes:
60+
label: Supported TD version
61+
description: A binding SHOULD correspond to specific TD specification version(s).
62+
options:
63+
- label: V1.0
64+
- label: V1.1
65+
- label: V2.0
66+
validations:
67+
required: true
68+
- type: input
69+
id: version
70+
attributes:
71+
label: Binding Version
72+
description: |
73+
A unique string for that entry's history that denotes the version of the entry that is linked.
74+
The version string SHOULD contain a UTC-based date in ISO 8601 format in the form of YYYY-MM-DD.
75+
validations:
76+
required: true
77+
- type: textarea
78+
id: summary
79+
attributes:
80+
label: Summary of the Binding
81+
description: |
82+
Provide summary about the binding.
83+
The content must comply with https://w3c.github.io/wot-binding-registry/#req-summ
84+
The placeholder is provided for convenience
85+
placeholder: |
86+
Abstract
87+
Examples
88+
Access and Usage Restrictions
89+
Dependent Bindings
90+
Available machine-readable documents (Schema, Ontology, JSON-LD Context)
91+
(if available) Link to the previous summary document
92+
(if relevant) Explanation about the versioning and ordering mechanism
93+
validations:
94+
required: true

‎.github/ISSUE_TEMPLATE/binding_transition_current.yaml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Binding Transition to Current
2+
description: |
3+
Use this template to submit a binding transition to current state, i.e., recommended for new implementations and it has enough implementation experience
4+
labels: ["binding-transition-current"]
5+
title: Provide the name and the version of the Binding, e.g. "Web of Things (WoT) HTTP Binding v2024-07-26"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
> [!Note]
11+
Thank you for submitting the binding transition to current state.
12+
Please provide the information in this template for the custodian to review the transition.
13+
Current state indicates that the binding is recommended for new implementations and it has enough implementation experience.
14+
- type: markdown
15+
attributes:
16+
value: |
17+
> [!Note]
18+
Please make sure to comply with our Code of Conduct (https://www.w3.org/policies/code-of-conduct/).
19+
It defines expected and unacceptable behaviors and promotes high standards of professional practice.
20+
The custodian is encouraged to apply necessary measures when necessary.
21+
- type: input
22+
id: name
23+
attributes:
24+
label: Name and Version of the Binding
25+
description: |
26+
Examples: Web of Things (WoT) HTTP Binding v2024-07-26, Web of Things (WoT) CoAP Binding v2024-07-26
27+
validations:
28+
required: true
29+
- type: input
30+
id: link
31+
attributes:
32+
label: Link to the binding document
33+
description: |
34+
The exact link from the registry table which you want to transition to current state.
35+
validations:
36+
required: true
37+
- type: dropdown
38+
id: submitter-relationship
39+
attributes:
40+
label: Relationship to the Submitter
41+
description: |
42+
Are you related to the original submitter of the binding you want to transition to current state?
43+
options:
44+
- label: Yes, I am the original submitter or an authorized representative
45+
- label: No, I am not related to the original submitter
46+
validations:
47+
required: true
48+
- type: input
49+
id: link-test-report
50+
attributes:
51+
label: Link to the test report
52+
description: |
53+
The link to the test report that demonstrates the binding has enough implementation experience.
54+
Please refer to https://w3c.github.io/wot-binding-registry/#req-trancurr for more details on the test report requirements.
55+
validations:
56+
required: true

‎.github/ISSUE_TEMPLATE/binding_transition_obsolete.yaml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Binding Transition to Obsolete
2+
description: |
3+
Use this template to submit a binding transition to obsolete state, i.e., not recommend the usage of this binding
4+
labels: ["binding-transition-obsolete"]
5+
title: Provide the name and the version of the Binding, e.g. "Web of Things (WoT) HTTP Binding v2024-07-26"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
> [!Note]
11+
Thank you for submitting the binding transition to obsolete state. Please provide the information in this template for the custodian to review the transition. If a newer version of the binding is available, please submit a transition to superseded state instead. Obsolete state indicates that the binding is no longer recommended for use.
12+
- type: markdown
13+
attributes:
14+
value: |
15+
> [!Note]
16+
Please make sure to comply with our Code of Conduct (https://www.w3.org/policies/code-of-conduct/).
17+
It defines expected and unacceptable behaviors and promotes high standards of professional practice.
18+
The custodian is encouraged to apply necessary measures when necessary.
19+
- type: input
20+
id: name
21+
attributes:
22+
label: Name and Version of the Binding
23+
description: |
24+
Examples: Web of Things (WoT) HTTP Binding v2024-07-26, Web of Things (WoT) CoAP Binding v2024-07-26
25+
validations:
26+
required: true
27+
- type: input
28+
id: link
29+
attributes:
30+
label: Link to the binding document
31+
description: |
32+
The exact link from the registry table which you want to transition to obsolete state.
33+
validations:
34+
required: true
35+
- type: dropdown
36+
id: submitter-relationship
37+
attributes:
38+
label: Relationship to the Submitter
39+
description: |
40+
Are you related to the original submitter of the binding you want to transition to obsolete state?
41+
options:
42+
- label: Yes, I am the original submitter or an authorized representative
43+
- label: No, I am not related to the original submitter
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: reason
48+
attributes:
49+
label: Reason to transition to Obsolete
50+
description: |
51+
Explanation with objective reasons to transition the binding to obsolete state.
52+
validations:
53+
required: true

‎.github/ISSUE_TEMPLATE/binding_transition_superseded.yaml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Binding Transition to Superseded
2+
description: |
3+
Use this template to submit a binding transition to superseded state, i.e., a new binding whose state is current is replacing this one
4+
labels: ["binding-transition-superseded"]
5+
title: Provide the name and the version of the Binding, e.g. "Web of Things (WoT) HTTP Binding v2024-07-26"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
> [!Note]
11+
Thank you for submitting the binding transition to superseded state. Please provide the information in this template for the custodian to review the transition. If a newer version of the binding is not available, please submit a transition to obsolete state instead. Superseded state indicates that a newer version of the binding is available.
12+
- type: markdown
13+
attributes:
14+
value: |
15+
> [!Note]
16+
Please make sure to comply with our Code of Conduct (https://www.w3.org/policies/code-of-conduct/).
17+
It defines expected and unacceptable behaviors and promotes high standards of professional practice.
18+
The custodian is encouraged to apply necessary measures when necessary.
19+
- type: input
20+
id: name
21+
attributes:
22+
label: Name and Version of the Binding
23+
description: |
24+
Examples: Web of Things (WoT) HTTP Binding v2024-07-26, Web of Things (WoT) CoAP Binding v2024-07-26
25+
validations:
26+
required: true
27+
- type: input
28+
id: link-old
29+
attributes:
30+
label: Link to the binding document that is superseded
31+
description: |
32+
The exact link from the registry table which you want to transition to superseded state.
33+
validations:
34+
required: true
35+
- type: input
36+
id: link-new
37+
attributes:
38+
label: Link to the new binding document that supersedes the previous one
39+
description: |
40+
The exact link from the registry table which is the new binding that supersedes the previous one.
41+
validations:
42+
required: true
43+
- type: dropdown
44+
id: submitter-relationship
45+
attributes:
46+
label: Relationship to the Submitter
47+
description: |
48+
Are you related to the original submitter of the binding you want to transition to superseded state?
49+
options:
50+
- label: Yes, I am the original submitter or an authorized representative
51+
- label: No, I am not related to the original submitter
52+
validations:
53+
required: true

0 commit comments

Comments
 (0)