Initial Commit

.formatter.exs

@@ -0,0 +1,4 @@
+[
+  plugins: [Styler],
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, 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 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
+[email protected].
+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].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

@@ -0,0 +1,136 @@
+# Contributing to `senzing`
+
+## Welcome!
+
+We look forward to your contributions! Here are some examples how you can
+contribute:
+
+- [Report a bug](https://github.com/sustema-ag/senzing-elixir/issues/new?labels=bug&template=BUG.md)
+- [Propose a new feature](https://github.com/sustema-ag/senzing-elixir/issues/new?labels=enhancement&template=FEATURE.md)
+- [Send a pull request](https://github.com/sustema-ag/senzing-elixir/pulls)
+
+## We have a Code of Conduct
+
+Please note that this project is released with a
+[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this
+project you agree to abide by its terms.
+
+## Any contributions you make will be under the MIT License
+
+When you submit code changes, your submissions are understood to be under the
+same [MIT](https://github.com/sustema-ag/senzing-elixir/blob/main/LICENSE)
+that covers the project. By contributing to this project, you agree that your
+contributions will be licensed under its MIT License.
+
+## Write bug reports with detail, background, and sample code
+
+In your bug report, please provide the following:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you
+- tried that didn't work)
+
+Please do not report a bug for a version of `senzing-elixir` that is no longer
+supported. Please do not report a bug if you are using a version of Erlang or
+Elixir that is not supported by the version of `senzing-elixir` you are using.
+
+Please post code and output as text
+([using proper markup](https://guides.github.com/features/mastering-markdown/)).
+Do not post screenshots of code or output.
+
+## Workflow for Pull Requests
+
+1. Fork the repository.
+2. Create your branch from `main` if you plan to implement new functionality or
+   change existing code significantly; create your branch from the oldest branch
+   that is affected by the bug if you plan to fix a bug.
+3. Implement your change and add tests for it.
+4. Ensure the test suite passes.
+5. Ensure the code complies with our coding guidelines (see below).
+6. Send that pull request!
+
+Please make sure you have
+[set up your user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)
+for use with Git. Strings such as `silly nick name <root@localhost>` look really
+stupid in the commit history of a project.
+
+We encourage you to
+[sign your Git commits with your GPG key](https://docs.github.com/en/github/authenticating-to-github/signing-commits).
+
+Pull requests for new features must be based on the `main` branch.
+
+We are trying to keep backwards compatibility breaks in `senzing` to a minimum.
+Please take this into account when proposing changes.
+
+Due to time constraints, we are not always able to respond as quickly as we
+would like. Please do not take delays personal and feel free to remind us if you
+feel that we forgot to respond.
+
+## Coding Guidelines
+
+This project comes with configured linters (located in `.credo.exs` in the
+repository) that you can use to perform various checks:
+
+```bash
+$ mix credo
+```
+
+This project comes with configuration (located in `.formatter.exs` in the
+repository) that you can use to (re)format your
+source code for compliance with this project's coding guidelines:
+
+```bash
+$ mix format
+```
+
+This project uses `dialyzer` to perform static code checking. Run it to make
+sure that your code is valid:
+
+```bash
+$ mix dialyzer
+```
+
+Please understand that we will not accept a pull request when its changes
+violate this project's coding guidelines.
+
+## Using `senzing` from a Git checkout
+
+The following commands can be used to perform the initial checkout of
+`senzing`:
+
+```bash
+$ git clone [email protected]:sustema-ag/senzing-elixir.git
+
+$ cd senzing-elixir
+```
+
+Install `senzing`'s dependencies using [mix](https://hexdocs.pm/mix/Mix.html):
+
+```bash
+$ mix deps.get
+```
+
+## Running `senzing`'s test suite
+
+After following the steps shown above, `senzing`'s test suite is run like
+this:
+
+```bash
+$ mix test
+```
+
+## Generating `senzing` Documentation
+
+To generate the documentation for the library, run:
+
+```bash
+$ mix docs
+```
+
+<!-- TODO: Add when guides are added -->
+<!-- The guide documentation pages can be found in the `/guides/` directory. -->

.github/ISSUE_TEMPLATE/BUG.yml

@@ -0,0 +1,65 @@
+name: 🐞 Bug Report
+description: Something is broken?
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        - Create a discussion instead if you are looking for support:
+          https://github.com/sustema-ag/senzing-elixir/discussions
+  - type: input
+    id: version
+    attributes:
+      label: senzing version
+      placeholder: x.y.z
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: senzing-elixir version
+      placeholder: x.y.z
+    validations:
+      required: true
+  - type: input
+    id: erlang-version
+    attributes:
+      label: Erlang version
+      placeholder: x.y.z
+    validations:
+      required: true
+  - type: input
+    id: elixir-version
+    attributes:
+      label: Elixir version
+      placeholder: x.y.z
+    validations:
+      required: true
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: Provide a summary describing the problem you are experiencing.
+    validations:
+      required: true
+  - type: textarea
+    id: current-behaviour
+    attributes:
+      label: Current behavior
+      description: What is the current (buggy) behavior?
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: How to reproduce
+      description: Provide steps to reproduce the bug.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behaviour
+    attributes:
+      label: Expected behavior
+      description: What was the expected (correct) behavior?
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/FEATURE.yml

@@ -0,0 +1,11 @@
+name: 🎉 Feature Request
+description: You have a neat idea that should be implemented?
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Provide a summary of the feature you would like to see implemented.
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+Please go the the `Preview` tab and select the appropriate sub-template:
+
+- [🐞 Bug Fix](?expand=1&template=FIX.md)
+- [⚙ Improvement](?expand=1&template=IMPROVEMENT.md)
+- [🎉 New Feature](?expand=1&template=NEW_FEATURE.md)

.github/PULL_REQUEST_TEMPLATE/FIX.md

@@ -0,0 +1,10 @@
+<!---
+name: 🐞 Bug Fix
+about: You have a fix for a bug?
+labels: bug
+--->
+
+<!--
+- Please target the oldest branch of senzing that is still supported and
+  affected by this bug.
+-->

.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md

@@ -0,0 +1,9 @@
+<!---
+name: ⚙ Improvement
+about: You have some improvement to make senzing better?
+labels: enhancement
+--->
+
+<!--
+- Please target the `main` branch of senzing.
+-->

.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md

@@ -0,0 +1,9 @@
+<!---
+name: 🎉 New Feature
+about: You have implemented some neat idea that you want to make part of senzing?
+labels: enhancement
+--->
+
+<!--
+- Please target the `main` branch of senzing.
+-->