Skip to content
This repository was archived by the owner on Feb 22, 2024. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (54 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

79 lines (54 loc) · 2.48 KB

Contributing to jsonpath-reference-implementation

The jsonpath-reference-implementation project team welcomes contributions from the community.

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Create a topic branch from where you want to base your work
  • Make commits of logical units
  • Make sure your commit messages are in the proper format (see below)
  • Push your changes to a topic branch in your fork of the repository
  • Submit a pull request

Example:

git remote add upstream https://github.com/jsonpath-standard/jsonpath-reference-implementation.git
git checkout -b my-new-feature main
git commit -a
git push origin my-new-feature

See the Developer Guide for how to set up a development environment and run the tests. If you want to make a small change, e.g. to fix a typo, you don't have to set up a development environment as the tests will run automatically against any pull request.

Staying In Sync With Upstream

When your branch gets out of sync with the jsonpath-standard/jsonpath-reference-implementation/main branch, use the following to update:

git checkout my-new-feature
git fetch -a
git pull --rebase upstream main
git push --force-with-lease origin my-new-feature

Updating pull requests

If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into existing commits.

If your pull request contains a single commit or your changes are related to the most recent commit, you can simply amend the commit.

git add .
git commit --amend
git push --force-with-lease origin my-new-feature

If you need to squash changes into an earlier commit, you can use:

git add .
git commit --fixup <commit>
git rebase -i --autosquash main
git push --force-with-lease origin my-new-feature

Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a notification when you git push.

Code Style

Formatting Commit Messages

We follow the conventions on How to Write a Git Commit Message.

Be sure to include any related GitHub issue references in the commit message. See GFM syntax for referencing issues and commits.

Reporting Bugs and Creating Issues

When opening a new issue, try to roughly follow the commit message format conventions above.