Skip to content

Commit

Permalink
Create TEMPLATE.md (#36)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
innovate-invent authored Mar 7, 2022
1 parent 72948b5 commit 1f691c3
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 21 deletions.
36 changes: 15 additions & 21 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
<!--
Thank you for your interest in contributing to the JMESPath Specification.
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.
This PR should include a JEP specification file based off TEMPLATE.md, named with the pattern "jep-###-title.md".
Additionally, the PR should include any intended modifications to the GRAMMAR file.
Please complete the required sections below:
-->

# \<TITLE>

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

## Abstract

## Motivation
*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*

For example, suppose we had this data:

```
{"first_choice": "WA",
"states": [
{"name": "WA", "cities": ["Seattle", "Bellevue", "Olympia"]},
{"name": "CA", "cities": ["Los Angeles", "San Francisco"]},
{"name": "NY", "cities": ["New York City", "Albany"]},
]
}
```
## Specification

Describe the grammar changes or new functions.

## Rationale
## Abstract

Why problems is this JEP addressing?
Has alternatives been considered?
\<copy from JEP>

## Implementation Survey

Expand Down
37 changes: 37 additions & 0 deletions TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# \<TITLE>

|||
|---|---
| **JEP** |
| **Author** | \<author>
| **Created**| \<date>
| **[SemVer](https://semver.org/spec/v2.0.0.html#summary)** | MAJOR\|MINOR\|PATCH

## Abstract

## Motivation

For example, suppose we had this data:

```
{"first_choice": "WA",
"states": [
{"name": "WA", "cities": ["Seattle", "Bellevue", "Olympia"]},
{"name": "CA", "cities": ["Los Angeles", "San Francisco"]},
{"name": "NY", "cities": ["New York City", "Albany"]},
]
}
```

## Specification

Describe the grammar changes or new functions.

## Rationale

What problems is this JEP addressing?
Has alternatives been considered?

## Implementation Notes

Are there any details that implementers should try to follow?

0 comments on commit 1f691c3

Please sign in to comment.