|
| 1 | +# Contributing |
| 2 | + |
| 3 | +We work hard to provide a high-quality and useful CLI, and we greatly value |
| 4 | +feedback and contributions from our community. Whether it's a new feature, |
| 5 | +correction, or additional documentation, we welcome your pull requests. Please |
| 6 | +submit any [issues](https://github.com/jmespath/jp/issues) |
| 7 | +or [pull requests](https://github.com/jmespath/jp/pulls) |
| 8 | +through GitHub. |
| 9 | + |
| 10 | +This document contains guidelines for contributing code and filing issues. |
| 11 | + |
| 12 | +## Contributing Code |
| 13 | + |
| 14 | +This list below are guidelines to use when submitting pull requests. |
| 15 | +These are the same set of guidelines that the core contributors use |
| 16 | +when submitting changes, and we ask the same of all community |
| 17 | +contributions as well: |
| 18 | + |
| 19 | +* We maintain a high percentage of code coverage in our tests. As a general |
| 20 | + rule of thumb, code changes should not lower the overall code coverage |
| 21 | + percentage for the project. In practice, this means that every bug fix and |
| 22 | + feature addition should include tests. |
| 23 | +* All PRs must run cleanly through `make test`. |
| 24 | + in more detail in the sections below. |
| 25 | + |
| 26 | + |
| 27 | +## Feature Development |
| 28 | + |
| 29 | +This CLI is designed to be a reference CLI implementation of JMESPath, |
| 30 | +and implements the official JMESPath specification. As such, we do not |
| 31 | +accept feature requests that are not part of the official JMESPath |
| 32 | +specification. If you would like to propose changes to the JMESPath |
| 33 | +language itself, which includes new syntax, functions, operators, etc., |
| 34 | +you can create a JMESPath enhancement proposal in the |
| 35 | +[jmespath.jep repository](https://github.com/jmespath/jmespath.jep). |
| 36 | +Once the proposal is accepted, we can then implement the changes in this |
| 37 | +CLI. |
| 38 | + |
| 39 | +## Running Tests |
| 40 | + |
| 41 | +To run the tests, you can run `make test`. |
0 commit comments