docs: changelog, code of conduct, contributing

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2022-07-15
+
+### Features
+
+- Engine implementation for child and recursive selectors.
+
+<!-- generated by git-cliff -->

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in 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, 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 e-mail 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
+mat@gienieczko.com.
+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.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,94 @@
+# How to contribute
+
+- Found a bug? Check if it was reported yet as a
+[![GitHub issues by-label](https://img.shields.io/github/issues/v0ldek/rsonpath/bug?color=%23d73a4a&label=bug&logo=github)](https://github.com/v0ldek/rsonpath/labels/bug),
+if not then file an [issue](https://github.com/V0ldek/rsonpath/issues/new)
+- Want a feature? Check if it's already proposed as an
+[![enhancement issues](https://img.shields.io/github/issues/v0ldek/rsonpath/enhancement?color=%23a2eeef&label=enhancement&logo=github)](https://github.com/v0ldek/rsonpath/labels/enhancement)
+, if not then file an [issue](https://github.com/V0ldek/rsonpath/issues/new)
+
+Every newly created issue gets assigned the
+[![triage issues](https://img.shields.io/github/issues/v0ldek/rsonpath/triage?color=%2384A6B5&label=triage&logo=github)](https://github.com/v0ldek/rsonpath/labels/triage)
+label. Once reviewed,
+I exchange it for
+[![go ahead issues](https://img.shields.io/github/issues/v0ldek/rsonpath/go%20ahead?color=%23FF4400&label=go%20ahead&logo=github)](https://github.com/v0ldek/rsonpath/labels/go%20ahead)
+to signal it is of value to the project and
+can be worked on (for a feature), or that it is indeed a bug that we need to fix (for a bug).
+
+## Code contributions
+
+You want to write code for the crate? Great! First, you need an issue to contribute to,
+one marked as
+[![go ahead issues](https://img.shields.io/github/issues/v0ldek/rsonpath/go%20ahead?color=%23FF4400&label=go%20ahead&logo=github)](https://github.com/v0ldek/rsonpath/labels/go%20ahead).
+You can also use
+[![help wanted issues](https://img.shields.io/github/issues/v0ldek/rsonpath/help%20wanted?color=%23008672&label=help%20wanted&logo=github)](https://github.com/v0ldek/rsonpath/labels/help%20wanted),
+meaning "I'd be very happy if someone implemented this",
+or
+[![good first issue issues](https://img.shields.io/github/issues/v0ldek/rsonpath/good%20first%20issue?color=%237057ff&label=good%20first%20issue&logo=github)](https://github.com/v0ldek/rsonpath/labels/good%20first%20issue),
+meaning "I'd be happy if someone implemented this and it's relatively straightforward".
+Go to the issue and post a comment that you're going to work on it. [Fork the repo](https://github.com/V0ldek/rsonpath/fork),
+write your feature of fix, then create a PR.
+
+### Setting up local development
+
+The only non-standard tool that you might need is [`cargo-hack`](https://lib.rs/crates/cargo-hack) and Python.
+You can install the former with
+
+```bash
+cargo install cargo-hack
+```
+
+To run the test suite locally use:
+
+```bash
+cargo hack test --feature-powerset --skip default --package rsonpath
+```
+
+or the shorthand
+
+```bash
+cargo rsontest --package rsonpath
+```
+
+**Note:** this requires your machine to support AVX2, as it is the default set in `.cargo/config.toml`.
+
+### Guidelines
+
+1. Use standard `rustfmt` settings for formatting.
+2. Lint your code with [`clippy`](https://github.com/rust-lang/rust-clippy).
+3. Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), more on it below.
+4. Avoid adding new dependencies to Cargo.toml unless there is a good reason for them.
+
+### Commit messages
+
+Your commit messages should look like this:
+
+```
+type: short description of changes
+
+More detailed description of my change.
+Potentially multiline.
+
+Refs: #69
+
+# This project follows Conventional Commits 1.0.0 (https://www.conventionalcommits.org/en/v1.0.0/)
+#
+# The first line should be a short description of the purpose of the commit.
+# Allowed types are: build, ci, docs, feat, fix, perf, refactor, style, test, chore
+#
+###
+# Note: If introducing a breaking change, add an exclamation mark after the type
+# Example: fix!: removed `AsRef` impl in favour of `relax_alignment`
+### 
+# The second section contains a detailed description.
+# Always give a description for features,
+# omit only for real one-liners like dependency bumps.
+# Footer are at the end. Most important are refs, 
+# which tell us which GitHub issue the change is related to, if any.
+###
+# Example:
+###
+# feat: add dot wildcard selector
+#
+# Refs: #69
+```

cliff.toml

@@ -0,0 +1,74 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | trim_start_matches(pat="1") | trim_start_matches(pat="2") | trim_start_matches(pat="3") | trim_start_matches(pat="4") | trim_start_matches(pat="5") | upper_first }}
+    {% for commit in commits %}
+        #### {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}.
+        {% if commit.body %}\
+            {% for message in commit.body | split(pat="\n") %}\
+                {% if message %}\
+                    - {{ message | trim | trim_start_matches(pat="-") }}
+                {% endif %}\
+            {% endfor %}\
+        {% endif %}\
+        {% if commit.links %}
+            <tiny>Related: \
+            {% for link in commit.links %}\
+                [{{ link.text }}]({{ link.href }}) \
+            {% endfor %}\
+            </tiny>
+        {% endif %}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "1Features"},
+    { message = "^fix", group = "2Bug Fixes"},
+    { message = "^perf", group = "3Performance"},
+    { message = "^test", group = "4Reliability"},
+    { message = "^ci", group = "4Reliability"},
+    { message = "^deps", group = "5Dependencies"},
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = true
+# glob pattern for matching git tags
+tag_pattern = "v[0-9]*"
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"
+# regex for ignoring tags
+ignore_tags = ""
+# sort the tags chronologically
+date_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# An array of link parsers for extracting external references, and turning them into URLs, using regex.
+link_parsers = [
+    { pattern = "#(\\d+)", href = "https://github.com/V0ldek/rsonpath/issues/$1" }
+]