Merge pull request #59 from dbluhm/fix/repolint

chore: add documents required by repolint

CHANGELOG.md

@@ -0,0 +1,23 @@
+> **Note on plugin versions and ACA-Py**: To avoid a confusing pseudo-lock-step
+> release, this plugin is versioned independent of ACA-Py. Plugin releases will
+> follow standard [semver](semver.org) but each release will also be tagged with
+> a mapping to an ACA-Py version with the format `acapy-X.Y.Z-J` where `X.Y.Z`
+> corresponds to the ACA-Py version supported and `J` is an incrementing number
+> for each new plugin release that targets the same version of ACA-Py.
+>
+> You should look for the most recent release tagged with the version of ACA-Py
+> you are using (with the highest value for `J`).
+
+# 0.1.0
+
+## May 14, 2021
+
+This marks the first official release of the Aries Cloud Agent - Python Toolbox
+Plugin. This Plugin implements the protocols defined by the [Aries
+Toolbox][aries-toolbox]. For details of the protocols added to ACA-Py by this
+plugin, see the [Toolbox Documentation][toolbox-docs]
+
+This version is compatible with ACA-Py 0.6.0.
+
+[aries-toolbox]: https://github.com/hyperledger/aries-toolbox
+[toolbox-docs]: https://github.com/hyperledger/aries-toolbox/tree/main/docs

CODE_OF_CONDUCT.md

@@ -0,0 +1,166 @@
+# [Hyperledger Code of Conduct](https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct)
+
+Hyperledger is a collaborative project at The Linux Foundation. It is an open-source and open
+community project where participants choose to work together, and in that process experience
+differences in language, location, nationality, and experience. In such a diverse environment,
+misunderstandings and disagreements happen, which in most cases can be resolved informally. In rare
+cases, however, behavior can intimidate, harass, or otherwise disrupt one or more people in the
+community, which Hyperledger will not tolerate.
+
+A **Code of Conduct** is useful to define accepted and acceptable behaviors and to promote high
+standards of professional practice. It also provides a benchmark for self evaluation and acts as a
+vehicle for better identity of the organization.
+
+This code (**CoC**) applies to any member of the Hyperledger community – developers, participants in
+meetings, teleconferences, mailing lists, conferences or functions, etc. Note that this code
+complements rather than replaces legal rights and obligations pertaining to any particular
+situation.
+
+## Statement of Intent
+
+Hyperledger is committed to maintain a **positive** [work environment](#work-environment). This
+commitment calls for a workplace where [participants](#participant) at all levels behave according
+to the rules of the following code. A foundational concept of this code is that we all share
+responsibility for our work environment.
+
+## Code
+
+1. Treat each other with [respect](#respect), professionalism, fairness, and sensitivity to our many
+   differences and strengths, including in situations of high pressure and urgency.
+
+2. Never [harass](#harassment) or [bully](#workplace-bullying) anyone verbally, physically or
+   [sexually](#sexual-harassment).
+
+3. Never [discriminate](#discrimination) on the basis of personal characteristics or group
+   membership.
+
+4. Communicate constructively and avoid [demeaning](#demeaning-behavior) or
+   [insulting](#insulting-behavior) behavior or language.
+
+5. Seek, accept, and offer objective work criticism, and [acknowledge](#acknowledgement) properly
+   the contributions of others.
+
+6. Be honest about your own qualifications, and about any circumstances that might lead to conflicts
+   of interest.
+
+7. Respect the privacy of others and the confidentiality of data you access.
+
+8. With respect to cultural differences, be conservative in what you do and liberal in what you
+   accept from others, but not to the point of accepting disrespectful, unprofessional or unfair or
+   [unwelcome behavior](#unwelcome-behavior) or [advances](#unwelcome-sexual-advance).
+
+9. Promote the rules of this Code and take action (especially if you are in a
+   [leadership position](#leadership-position)) to bring the discussion back to a more civil level
+   whenever inappropriate behaviors are observed.
+
+10. Stay on topic: Make sure that you are posting to the correct channel and avoid off-topic
+    discussions. Remember when you update an issue or respond to an email you are potentially
+    sending to a large number of people.
+
+11. Step down considerately: Members of every project come and go, and the Hyperledger is no
+    different. When you leave or disengage from the project, in whole or in part, we ask that you do
+    so in a way that minimizes disruption to the project. This means you should tell people you are
+    leaving and take the proper steps to ensure that others can pick up where you left off.
+
+## Glossary
+
+### Demeaning Behavior
+
+is acting in a way that reduces another person's dignity, sense of self-worth or respect within the
+community.
+
+### Discrimination
+
+is the prejudicial treatment of an individual based on criteria such as: physical appearance, race,
+ethnic origin, genetic differences, national or social origin, name, religion, gender, sexual
+orientation, family or health situation, pregnancy, disability, age, education, wealth, domicile,
+political view, morals, employment, or union activity.
+
+### Insulting Behavior
+
+is treating another person with scorn or disrespect.
+
+### Acknowledgement
+
+is a record of the origin(s) and author(s) of a contribution.
+
+### Harassment
+
+is any conduct, verbal or physical, that has the intent or effect of interfering with an individual,
+or that creates an intimidating, hostile, or offensive environment.
+
+### Leadership Position
+
+includes group Chairs, project maintainers, staff members, and Board members.
+
+### Participant
+
+includes the following persons:
+
+- Developers
+- Member representatives
+- Staff members
+- Anyone from the Public partaking in the Hyperledger work environment (e.g. contribute code,
+  comment on our code or specs, email us, attend our conferences, functions, etc)
+
+### Respect
+
+is the genuine consideration you have for someone (if only because of their status as participant in
+Hyperledger, like yourself), and that you show by treating them in a polite and kind way.
+
+### Sexual Harassment
+
+includes visual displays of degrading sexual images, sexually suggestive conduct, offensive remarks
+of a sexual nature, requests for sexual favors, unwelcome physical contact, and sexual assault.
+
+### Unwelcome Behavior
+
+Hard to define? Some questions to ask yourself are:
+
+- how would I feel if I were in the position of the recipient?
+- would my spouse, parent, child, sibling or friend like to be treated this way?
+- would I like an account of my behavior published in the organization's newsletter?
+- could my behavior offend or hurt other members of the work group?
+- could someone misinterpret my behavior as intentionally harmful or harassing?
+- would I treat my boss or a person I admire at work like that ?
+- Summary: if you are unsure whether something might be welcome or unwelcome, don't do it.
+
+### Unwelcome Sexual Advance
+
+includes requests for sexual favors, and other verbal or physical conduct of a sexual nature, where:
+
+- submission to such conduct is made either explicitly or implicitly a term or condition of an
+  individual's employment,
+- submission to or rejection of such conduct by an individual is used as a basis for employment
+  decisions affecting the individual,
+- such conduct has the purpose or effect of unreasonably interfering with an individual's work
+  performance or creating an intimidating hostile or offensive working environment.
+
+### Workplace Bullying
+
+is a tendency of individuals or groups to use persistent aggressive or unreasonable behavior (e.g.
+verbal or written abuse, offensive conduct or any interference which undermines or impedes work)
+against a co-worker or any professional relations.
+
+### Work Environment
+
+is the set of all available means of collaboration, including, but not limited to messages to
+mailing lists, private correspondence, Web pages, chat channels, phone and video teleconferences,
+and any kind of face-to-face meetings or discussions.
+
+## Incident Procedure
+
+To report incidents or to appeal reports of incidents, send email to Mike Dolan
+(mdolan@linuxfoundation.org) or Angela Brown (angela@linuxfoundation.org). Please include any
+available relevant information, including links to any publicly accessible material relating to the
+matter. Every effort will be taken to ensure a safe and collegial environment in which to
+collaborate on matters relating to the Project. In order to protect the community, the Project
+reserves the right to take appropriate action, potentially including the removal of an individual
+from any and all participation in the project. The Project will work towards an equitable resolution
+in the event of a misunderstanding.
+
+## Credits
+
+This code is based on the
+[W3C’s Code of Ethics and Professional Conduct](https://www.w3.org/Consortium/cepc) with some
+additions from the [Cloud Foundry](https://www.cloudfoundry.org/)‘s Code of Conduct.

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+## How to contribute
+
+You are encouraged to contribute to the repository by **forking and submitting a
+pull request**.
+
+For significant changes, please open an issue first to discuss the proposed
+changes with the community and to avoid re-work.
+
+(If you are new to GitHub, you might start with a [basic tutorial][tutorial] and
+check out a more detailed guide to [pull requests][prs].)
+
+Pull requests will be evaluated by the repository guardians on a schedule and if
+deemed beneficial will be committed to the `main` branch. Pull requests should
+have a descriptive name, include an summary of all changes made in the pull
+request description, and include unit tests that provide good coverage of the
+feature or fix. A Continuous Integration (CI) pipeline is executed on all PRs
+before review and contributors are expected to address all CI issues identified.
+Where appropriate, PRs that impact the end-user and developer demos in the repo
+should include updates or extensions to those demos to cover the new
+capabilities.
+
+All contributors retain the original copyright to their stuff, but by
+contributing to this project, you grant a world-wide, royalty-free, perpetual,
+irrevocable, non-exclusive, transferable license to all users **under the terms
+of the [license](./LICENSE) under which this project is distributed.**
+
+[tutorial]: https://help.github.com/articles/set-up-git
+[prs]: https://help.github.com/articles/using-pull-requests/

MAINTAINERS.md

@@ -0,0 +1,71 @@
+# Maintainers
+
+## Active Maintainers
+
+<!-- Please keep this sorted alphabetically by github -->
+
+| Name             | Github           | LFID             |
+| ---------------- | ---------------- | ---------------- |
+| Adam Burdett     | burdettadam      | burdettadam      |
+| Daniel Bluhm     | dbluhm           | dbluhm           |
+| Sam Curren       | TelegramSam      | TelegramSam      |
+
+## Emeritus Maintainers
+
+| Name         | Github  | LFID    |
+|--------------|---------|---------|
+|   |  |  |
+
+## Becoming a Maintainer
+
+The ACA-Py Toolbox Plugin community welcomes contributions. Contributors may
+progress to become a maintainer. To become a maintainer the following steps
+occur, roughly in order.
+
+- 5 significant changes have been authored by the proposed maintainer and
+  accepted.
+- The proposed maintainer has the sponsorship of at least one other maintainer.
+  - This sponsoring maintainer will create a PR modifying the list of
+    maintainers.
+  - The proposed maintainer accepts the nomination and expresses a willingness
+    to be a long-term (more than 6 month) committer.
+  - This would be a comment in the above PR.
+  - This PR will be communicated in all appropriate communication channels. It
+    should be mentioned in any maintainer/community call. It should also be
+    posted to the appropriate mailing list or chat channels if they exist.
+- Approval by at least 3 current maintainers within two weeks of the proposal or
+  an absolute majority of current maintainers.
+  - These votes will be recorded in the PR modifying the list of maintainers.
+- No veto by another maintainer within two weeks of proposal are recorded.
+  - All vetoes must be accompanied by a public explanation as a comment in the
+    PR for adding this maintainer
+  - The explanation of the veto must be reasonable.
+  - A veto can be retracted, in that case the approval/veto timeframe is reset.
+  - It is bad form to veto, retract, and veto again.
+- The proposed maintainer becomes a maintainer
+  - Either two weeks have passed since the third approval,
+  - Or an absolute majority of maintainers approve.
+  - In either case, no maintainer presents a veto.
+
+## Removing Maintainers
+
+Being a maintainer is not a status symbol or a title to be maintained
+indefinitely. It will occasionally be necessary and appropriate to move a
+maintainer to emeritus status. This can occur in the following situations:
+
+- Resignation of a maintainer.
+- Violation of the Code of Conduct warranting removal.
+- Inactivity.
+  - A general measure of inactivity will be no commits or code review comments
+    for one reporting quarter, although this will not be strictly enforced if
+    the maintainer expresses a reasonable intent to continue contributing.
+  - Reasonable exceptions to inactivity will be granted for known long term
+    leave such as parental leave and medical leave.
+- Other unspecified circumstances.
+
+Like adding a maintainer the record and governance process for moving a
+maintainer to emeritus status is recorded in the github PR making that change.
+
+Returning to active status from emeritus status uses the same steps as adding a
+new maintainer. Note that the emeritus maintainer already has the 5 required
+significant changes as there is no contribution time horizon for those.

README.md

@@ -130,3 +130,7 @@ $ aca-py start \
 
 Note that you do not need to load any other plugins for this transport but you
 can by specifying `--plugin` as shown in the examples above.
+
+## License
+
+[Apache License Version 2.0](https://github.com/hyperledger/aries-acapy-plugin-toolbox/blob/main/LICENSE)

SECURITY.md

@@ -0,0 +1,20 @@
+# Hyperledger Security Policy
+
+## Reporting a Security Bug
+
+If you think you have discovered a security issue in any of the Hyperledger projects, we'd love to
+hear from you. We will take all security bugs seriously and if confirmed upon investigation we will
+patch it within a reasonable amount of time and release a public security bulletin discussing the
+impact and credit the discoverer.
+
+There are two ways to report a security bug. The easiest is to email a description of the flaw and
+any related information (e.g. reproduction steps, version) to
+[security at hyperledger dot org](mailto:security@hyperledger.org).
+
+The other way is to file a confidential security bug in our
+[JIRA bug tracking system](https://jira.hyperledger.org). Be sure to set the “Security Level” to
+“Security issue”.
+
+The process by which the Hyperledger Security Team handles security bugs is documented further in
+our [Defect Response page](https://wiki.hyperledger.org/display/SEC/Defect+Response) on our
+[wiki](https://wiki.hyperledger.org).