Skip to content

Commit

Permalink
docs: improve README clarity and fix typos (#177)
Browse files Browse the repository at this point in the history
- Enhance language count phrasing
- Fix implementation tracking redundancy
- Convert Gitter URL to markdown link
- Fix spelling of "superseded"

<!-- ps-id: e45a4ce5-272f-4de6-a40a-d8cc416a86b1 -->
  • Loading branch information
cawalch authored Dec 23, 2024
1 parent 341f0cc commit ff272c2
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project supports an ecosystem of high quality, fast paced implementations i

# JMESPath Specification

Any changes to the [JMESPath specification](https://jmespath.site/main/#specification) must have a JEP (JMESPath Enhancement Proposal) which is tracked in this repo. While there are implementations of JMESPath in over 9 different languages, we currently track implementations of 4 implementations of the JMESPath Community specification. We want to make sure that any modifications to the spec make sense for all JMESPath and JMESPath Community libraries.
Any changes to the [JMESPath specification](https://jmespath.site/main/#specification) must have a JEP (JMESPath Enhancement Proposal) which is tracked in this repo. While there are implementations of JMESPath in more than 9 different languages, we currently track 4 implementations of the JMESPath Community specification. We want to make sure that any modifications to the spec make sense for all JMESPath and JMESPath Community libraries.

A JEP helps to work through the design process for new additions and ensures that the JMESPath community has a chance to give feedback before it's officially part of the specification.

Expand All @@ -28,14 +28,13 @@ additional language specific APIs, extension points (e.g. adding custom function
First, make sure that the feature has not been previously proposed. If it has, make sure to reference prior proposals and explain why this new
proposal should be considered despite similar proposals not being accepted.

Writing a JEP can be a lot of work, so it can help to get initial guidance before getting too far. You can chat on the JMESPath gitter channel
(https://gitter.im/jmespath/chat) to get an initial pulse of a new feature.
Writing a JEP can be a lot of work, so it can help to get initial guidance before getting too far. You can chat on the JMESPath [gitter channel](https://gitter.im/jmespath/chat) to get an initial pulse of a new feature.

Then open a [discussion](https://github.com/jmespath-community/jmespath.spec/discussions) to discuss the feature, its merit, and any possible alternatives.
Once the discussion has reached a mature level of feedback, it will be assigned a JEP number _N_.
At that point it is safe to begin composing JEP-_N_ along with all the required changes and documentation.

In rare circumstances, JEPs will be superceded by newer versions of a JEP. Those
In rare circumstances, JEPs will be superseded by newer versions of a JEP. Those
updated JEPs will have an amended letter sequence added as a suffix to the original JEP#.
The sequence follows the 26 US-ASCII alphabetical order 'a', 'b', to 'z'. It then follows with
'aa', 'ab', to 'az' and so on.
Expand Down

0 comments on commit ff272c2

Please sign in to comment.