Skip to content

Commit 1f691c3

Browse files
Create TEMPLATE.md (#36)
* Create TEMPLATE.md We should use a different template for the JEP file vs the PR as they should contain different (but slightly overlapping) information. For example, I wouldn't include the implementation survey in the file, it is really only needed when considering merging a JEP. * Update pull_request_template.md * Update TEMPLATE.md
1 parent 72948b5 commit 1f691c3

File tree

2 files changed

+52
-21
lines changed

2 files changed

+52
-21
lines changed

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
Thank you for your interest in contributing to the JMESPath Specification.
3+
4+
Before creating a pull request, please ensure that the feature or change has been fully discussed in a discussion and the discussion has been assigned a JEP tag.
5+
6+
This PR should include a JEP specification file based off TEMPLATE.md, named with the pattern "jep-###-title.md".
7+
Additionally, the PR should include any intended modifications to the GRAMMAR file.
8+
9+
Please complete the required sections below:
10+
-->
11+
112
# \<TITLE>
213

314
|||
@@ -6,30 +17,13 @@
617
| **Author** | \<author>
718
| **Created**| \<date>
819
| **[SemVer](https://semver.org/spec/v2.0.0.html#summary)** | MAJOR\|MINOR\|PATCH
20+
| **[Discussion #](https://github.com/jmespath-community/jmespath.jep/discussions)** | [##](https://github.com/jmespath-community/jmespath.jep/discussions/##)
921

10-
## Abstract
11-
12-
## Motivation
22+
*Please discuss the merit of the JEP in the linked discussion. PR discussion should be limited to proofing the content of the PR and the PR proposal inital comment*
1323

14-
For example, suppose we had this data:
15-
16-
```
17-
{"first_choice": "WA",
18-
"states": [
19-
{"name": "WA", "cities": ["Seattle", "Bellevue", "Olympia"]},
20-
{"name": "CA", "cities": ["Los Angeles", "San Francisco"]},
21-
{"name": "NY", "cities": ["New York City", "Albany"]},
22-
]
23-
}
24-
```
25-
## Specification
26-
27-
Describe the grammar changes or new functions.
28-
29-
## Rationale
24+
## Abstract
3025

31-
Why problems is this JEP addressing?
32-
Has alternatives been considered?
26+
\<copy from JEP>
3327

3428
## Implementation Survey
3529

TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# \<TITLE>
2+
3+
|||
4+
|---|---
5+
| **JEP** |
6+
| **Author** | \<author>
7+
| **Created**| \<date>
8+
| **[SemVer](https://semver.org/spec/v2.0.0.html#summary)** | MAJOR\|MINOR\|PATCH
9+
10+
## Abstract
11+
12+
## Motivation
13+
14+
For example, suppose we had this data:
15+
16+
```
17+
{"first_choice": "WA",
18+
"states": [
19+
{"name": "WA", "cities": ["Seattle", "Bellevue", "Olympia"]},
20+
{"name": "CA", "cities": ["Los Angeles", "San Francisco"]},
21+
{"name": "NY", "cities": ["New York City", "Albany"]},
22+
]
23+
}
24+
```
25+
26+
## Specification
27+
28+
Describe the grammar changes or new functions.
29+
30+
## Rationale
31+
32+
What problems is this JEP addressing?
33+
Has alternatives been considered?
34+
35+
## Implementation Notes
36+
37+
Are there any details that implementers should try to follow?

0 commit comments

Comments
 (0)