Skip to content

Commit 377eb4c

Browse files
authored
Merge pull request jsonpath-standard#9 from glyn/licensing
Prepare to open the repository
2 parents e50b92b + 260d3d2 commit 377eb4c

File tree

3 files changed

+91
-22
lines changed

3 files changed

+91
-22
lines changed

CONTRIBUTING.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
2+
3+
# Contributing to jsonpath-reference-implementation
4+
5+
The jsonpath-reference-implementation project team welcomes contributions from the community.
6+
7+
## Contribution Flow
8+
9+
This is a rough outline of what a contributor's workflow looks like:
10+
11+
- Create a topic branch from where you want to base your work
12+
- Make commits of logical units
13+
- Make sure your commit messages are in the proper format (see below)
14+
- Push your changes to a topic branch in your fork of the repository
15+
- Submit a pull request
16+
17+
Example:
18+
19+
``` shell
20+
git remote add upstream https://github.com/jsonpath-standard/jsonpath-reference-implementation.git
21+
git checkout -b my-new-feature main
22+
git commit -a
23+
git push origin my-new-feature
24+
```
25+
26+
### Staying In Sync With Upstream
27+
28+
When your branch gets out of sync with the jsonpath-standard/jsonpath-reference-implementation/main branch, use the following to update:
29+
30+
``` shell
31+
git checkout my-new-feature
32+
git fetch -a
33+
git pull --rebase upstream main
34+
git push --force-with-lease origin my-new-feature
35+
```
36+
37+
### Updating pull requests
38+
39+
If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
40+
existing commits.
41+
42+
If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
43+
amend the commit.
44+
45+
``` shell
46+
git add .
47+
git commit --amend
48+
git push --force-with-lease origin my-new-feature
49+
```
50+
51+
If you need to squash changes into an earlier commit, you can use:
52+
53+
``` shell
54+
git add .
55+
git commit --fixup <commit>
56+
git rebase -i --autosquash main
57+
git push --force-with-lease origin my-new-feature
58+
```
59+
60+
Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a
61+
notification when you git push.
62+
63+
### Code Style
64+
65+
### Formatting Commit Messages
66+
67+
We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
68+
69+
Be sure to include any related GitHub issue references in the commit message. See
70+
[GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues
71+
and commits.
72+
73+
## Reporting Bugs and Creating Issues
74+
75+
When opening a new issue, try to roughly follow the commit message format conventions above.

LICENSE

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,15 @@
1-
Copyright (c) 2020, VMware, Inc. All rights reserved.
1+
jsonpath-reference-implementation
2+
The BSD-2 license (the "License") set forth below applies to all parts of the jsonpath-reference-implementation project. You may not use this file except in compliance with the License.
3+
4+
BSD-2 License
5+
6+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
27

3-
Redistribution and use in source and binary forms, with or without
4-
modification, are permitted provided that the following conditions are met:
8+
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
59

6-
1. Redistributions of source code must retain the above copyright notice, this
7-
list of conditions and the following disclaimer.
8-
2. Redistributions in binary form must reproduce the above copyright notice,
9-
this list of conditions and the following disclaimer in the documentation
10-
and/or other materials provided with the distribution.
11-
12-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
13-
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14-
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
15-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
16-
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
17-
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18-
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
19-
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20-
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21-
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
10+
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
11+
12+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
13+
14+
15+

NOTICE

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
jsonpath-ri
2-
Copyright (c) 2020 VMware, Inc. All Rights Reserved.
1+
jsonpath-reference-implementation
2+
Copyright 2020 VMware, Inc.
33

4-
This product is licensed to you under the Simplified BSD license (the "License"). You may not use this product except in compliance with the Simplified BSD License.
4+
This product is licensed to you under the BSD-2 license (the "License"). You may not use this product except in compliance with the BSD-2 License.
55

66
This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
77

0 commit comments

Comments
 (0)