From e66cdc087933dfb418192454bdbf07cc69da930c Mon Sep 17 00:00:00 2001 From: Alexey Date: Sat, 13 Jul 2024 18:12:34 -0700 Subject: [PATCH] Add some guideline docs (#109) --- CODE_OF_CONDUCT.md | 123 +++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 69 +++++++++++++++++++++++++ README.md | 10 +++- 3 files changed, 200 insertions(+), 2 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e0c0f34 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,123 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in this project and our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..02e9dfb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,69 @@ +# Contributing to jessie + +The jessie project team welcomes contributions from the community. + +## Contribution Flow + +- Fork and clone the repository +- Create a topic branch from where you want to base your work +- Make commits of logical units +- Make sure the tests pass +- Push your changes to a topic branch in your fork of the repository +- Submit a pull request + +Example: + +``` shell +git remote add upstream git@github.com:f3ath/jessie.git +git checkout -b my-new-feature main +git commit -a +git push origin my-new-feature +``` + +### Running the Test Suite + +The test suite is included as a submodule. To run the tests, you need to initialize the submodule: + +``` shell +git submodule update --init +``` + +Then you can run the tests: + +``` shell +dart test +``` + +### Staying In Sync With Upstream + +When your branch gets out of sync with the jsonpath-standard/jessie/main branch, use the following to update: + +``` shell +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. + +``` shell +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: + +``` shell +git add . +git commit --fixup +git rebase -i --autosquash main +git push --force-with-lease origin my-new-feature +``` diff --git a/README.md b/README.md index 1995003..2334a1f 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,14 @@ [![GitHub Stars](https://img.shields.io/github/stars/f3ath/jessie.svg)](https://github.com/f3ath/jessie/stargazers) [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/f3ath/jessie/master/LICENSE) +JSONPath defines a string syntax for selecting and extracting JSON (RFC 8259) values from within a given JSON value. + +This library is a Dart implementation of the RFC 9535 [JsonPath] specification. It is also expected to pass the latest version +of the [Compliance Test Suite]. If you find a missing or incorrectly implemented feature, please open an issue. + +For installation instructions and a detailed API documentation, see the [pub.dev page](https://pub.dev/packages/json_path). + +### Usage example: ```dart import 'dart:convert'; @@ -68,8 +76,6 @@ void main() { } ``` -This library fully implements the RFC 9535 [JsonPath] specification. It also should pass the latest version -of the [Compliance Test Suite]. If you find a missing or incorrectly implemented feature, please open an issue. ## Data manipulation Each `JsonPathMatch` produced by the `.read()` method contains the `.pointer` property which is a valid [JSON Pointer]