Skip to content

Commit ff078c2

Browse files
committed
Update
+ Updated README + Added issue templates + Updated PULL_REQUEST_TEMPLATE + Updated phpdoc blocks and removed tags that don't provide any useful information
1 parent 68f3b46 commit ff078c2

23 files changed

Lines changed: 393 additions & 219 deletions

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Submit a bug report, to help us improve.
4+
labels: "bug"
5+
---
6+
7+
## 🐛 Bug Report
8+
9+
(A clear and concise description of what the bug is)
10+
11+
## Have you spent some time to check if this issue has been raised before?
12+
13+
[ ] I have read googled for a similar issue or checked our older issues for a similar bug
14+
15+
### Have you read the [Code of Conduct](https://github.com/SoftCreatR/JSONPath/blob/main/CODE_OF_CONDUCT.md)?
16+
17+
[ ] I have read the Code of Conduct
18+
19+
## To Reproduce
20+
21+
(Write your steps here:)
22+
23+
## Expected behavior
24+
25+
<!--
26+
How did you expect your project to behave?
27+
It’s fine if you’re not sure your understanding is correct.
28+
Write down what you thought would happen.
29+
-->
30+
31+
(Write what you thought would happen.)
32+
33+
## Actual Behavior
34+
35+
<!--
36+
Did something go wrong?
37+
Is something broken, or not behaving as you expected?
38+
Describe this section in detail, and attach screenshots if possible.
39+
Don't only say "it doesn't work"!
40+
-->
41+
42+
(Write what happened. Add screenshots, if applicable.)
43+
44+
## Your Environment
45+
46+
<!-- Include as many relevant details about the environment you experienced the bug in -->
47+
48+
(Write Environment, Operating system and version etc.)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: 📚 Documentation
3+
about: Report an issue related to documentation.
4+
labels: "documentation"
5+
---
6+
7+
## 📚 Documentation
8+
9+
(A clear and concise description of what the issue is.)
10+
11+
### Have you read the [Code of Conduct](https://github.com/SoftCreatR/JSONPath/blob/main/CODE_OF_CONDUCT.md)?
12+
13+
[ ] I have read the Code of Conduct

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: 💡 Feature / Idea
3+
about: Submit a proposal for a new feature.
4+
labels: "feature"
5+
---
6+
7+
## 💡 Feature / Idea
8+
9+
(A clear and concise description of what the feature is.)
10+
11+
## Have you spent some time to check if this issue has been raised before?
12+
13+
[ ] I have read googled for a similar issue or checked our older issues for a similar idea
14+
15+
### Have you read the [Code of Conduct](https://github.com/SoftCreatR/JSONPath/blob/main/CODE_OF_CONDUCT.md)?
16+
17+
[ ] I have read the Code of Conduct
18+
19+
## Pitch
20+
21+
(Please explain why this feature should be implemented and how it would be used. Add examples, if applicable.)

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!--
2+
Thank you for sending the PR! We appreciate you spending the time to work on these changes.
3+
4+
Help us understand your motivation by explaining why you decided to make this change.
5+
6+
Happy contributing!
7+
8+
-->
9+
10+
# 🔀 Pull Request
11+
12+
## What does this PR do?
13+
14+
(Provide a description of what this PR does.)
15+
16+
## Test Plan
17+
18+
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)
19+
20+
## Related PRs and Issues
21+
22+
(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

.github/workflows/Test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
matrix:
2424
php: [ '7.1', '7.2', '7.3', '7.4', '8.0' ]
2525
continue-on-error: ${{ matrix.php == '8.0' }}
26-
name: PHP ${{ matrix.php-versions }} Test
26+
name: PHP ${{ matrix.php }} Test
2727

2828
steps:
2929
- name: Git checkout
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Update Contributors
3+
4+
on: [ push, workflow_dispatch]
5+
6+
jobs:
7+
Update:
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- name: Git checkout
12+
uses: actions/checkout@v2
13+
14+
- uses: BobAnkh/add-contributors@master
15+
with:
16+
REPO_NAME: 'SoftCreatR/JSONPath'
17+
CONTRIBUTOR: '## Contributors ✨'
18+
ACCESS_TOKEN: ${{secrets.GITHUB_TOKEN}}

CHANGELOG.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Changelog
2+
3+
### 0.7.2
4+
- Fixed query/selector "Array Slice With Start Large Negative Number And Open End On Short Array" (#7)
5+
- Fixed query/selector "Union With Keys" (#22)
6+
- Fixed query/selector "Dot Notation After Union With Keys" (#15)
7+
- Fixed query/selector "Union With Keys After Array Slice" (#23)
8+
- Fixed query/selector "Union With Keys After Bracket Notation" (#24)
9+
- Fixed query/selector "Union With Keys On Object Without Key" (#25)
10+
11+
### 0.7.1
12+
- Fixed issues with empty tokens (`['']` and `[""]`)
13+
- Fixed TypeError in AccessHelper::keyExists
14+
- Improved QueryTest
15+
16+
### 0.7.0
17+
🔻 Breaking changes ahead:
18+
19+
- Made JSONPath::__construct final
20+
- Added missing type hints
21+
- Partially reduced complexity
22+
- Performed some code optimizations
23+
- Updated composer.json for proper PHPUnit/PHP usage
24+
- Added support for regular expression operator (`=~`)
25+
- Added QueryTest to perform tests against all queries from https://cburgmer.github.io/json-path-comparison/
26+
- Switched Code Style from PSR-2 to PSR-12
27+
28+
### 0.6.4
29+
- Removed unnecessary type casting, that caused problems under certain circumstances
30+
- Added support for `nin` operator
31+
- Added support for greater than or equal operator (`>=`)
32+
- Added support for less or equal operator (`<=`)
33+
34+
### 0.6.3
35+
- Added support for `in` operator
36+
- Fixed evaluation on indexed object
37+
38+
### 0.6.x
39+
- Dropped support for PHP < 7.1
40+
- Switched from (broken) PSR-0 to PSR-4
41+
- Updated PHPUnit to 8.5 / 9.4
42+
- Updated tests
43+
- Added missing PHPDoc blocks
44+
- Added return type hints
45+
- Moved from Travis to GitHub actions
46+
- Set `strict_types=1`
47+
48+
### 0.5.0
49+
- Fixed the slice notation (e.g. [0:2:5] etc.). **Breaks code relying on the broken implementation**
50+
51+
### 0.3.0
52+
- Added JSONPathToken class as value object
53+
- Lexer clean up and refactor
54+
- Updated the lexing and filtering of the recursive token ("..") to allow for a combination of recursion
55+
and filters, e.g. $..[?(@.type == 'suburb')].name
56+
57+
### 0.2.1 - 0.2.5
58+
- Various bug fixes and clean up
59+
60+
### 0.2.0
61+
- Added a heap of array access features for more creative iterating and chaining possibilities
62+
63+
### 0.1.x
64+
- Init

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity, expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at hello@1-2.dev. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)