diff --git a/404.html b/404.html new file mode 100644 index 000000000..0cdbaf726 --- /dev/null +++ b/404.html @@ -0,0 +1,1341 @@ + + + +
+ + + + + + + + + + + + + + + + +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.
+Examples of behavior that contributes to a positive environment for our +community include:
+Examples of unacceptable behavior include:
+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.
+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.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +conduct@iohk.io. +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.
+Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct:
+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.
+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.
+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.
+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.
+This Code of Conduct is adapted from the Contributor Covenant, +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.
+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.
+ + + + + + +First off, thanks for taking the time to contribute! ❤️
+All types of contributions are encouraged and valued. +Please make sure to read the relevant section before making your contribution. +It will make it a lot easier for us maintainers and smooth out the experience for all involved. +The community looks forward to your contributions. 🎉
+This project and everyone participating in it is governed by the +Hermes Code of Conduct. +By participating, you are expected to uphold this code. +Please report unacceptable behavior +to code-of-conduct@iohk.io.
+++If you want to ask a question, we assume that you have read the available +Documentation.
+
Before you ask a question, it is best to search for existing +Issues +that might help you. +In case you have found a suitable issue and still need clarification, you can write your question +here. +It is also advisable to search the internet for answers first.
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+rustc --version --verbose
, flutter doctor -v
, etc),
+depending on what seems relevant.We will then take care of the issue as soon as possible.
+A good bug report shouldn't leave others needing to chase you up for more information. +Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. +Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+++You must never report security related issues, +vulnerabilities or bugs including sensitive information to the issue tracker, +or elsewhere in public. +Instead sensitive bugs must be sent by email to security@iohk.io.
+
We use GitHub issues to track bugs and errors. +If you run into an issue with the project:
+Once it's filed:
+needs-repro
.
+ Bugs with the needs-repro
tag will not be addressed until they are reproduced.bug
.
+ It may possibly be marked with other tags (such as critical
).
+ The issue will then be left to be implemented by someone.This section guides you through submitting an enhancement suggestion for Hermes, +including completely new features and minor improvements to existing functionality. +Following these guidelines will help maintainers and the community to understand your suggestion and +find related suggestions.
+Enhancement suggestions are tracked as GitHub issues.
+Embarking on your first code contribution can be an exhilarating yet intimidating endeavor. +Here at Hermes, we foster a welcoming and supportive environment to ensure +that everyone can contribute to the codebase irrespective of their experience level. +Below is a step-by-step guide to making your first code contribution to our repository:
+Set up the development environment following the instructions in the README.
+Pick an Issue:
+Pick an issue that interests you and aligns with your skills.
+ Beginners might look for issues tagged as good first issue
+ or beginner-friendly
.
Understand the Issue:
+Ask clarifying questions in the issue thread if necessary.
+Branch Out:
+It's a good practice to name your branch descriptively, e.g., fix-button-bug.
Work on the Issue:
+Adhere to the coding standards and guidelines provided in the Style guides section.
+Test Your Changes:
+Verify that your changes don't break any existing functionality.
+Commit Your Changes:
+Write a clear and concise commit message following the Style guides -> Commit Messages section guidelines.
+Push Your Changes:
+Push your changes to your fork on GitHub.
+Open a Pull Request:
+Provide a detailed description of your changes, the issue it addresses, + and any additional information that might help maintainers review your contribution.
+Review and Revision:
+Merge and Celebrate:
+Remember, every contributor was new at some point, and we are thrilled to welcome new members to our community. +The journey of becoming an adept open-source contributor is rewarding and educational. +Your contribution, no matter how small, can make a significant impact. +Happy coding!
+Documentation is a cornerstone of any successful open-source project. +It aids developers in understanding the purpose, structure, and functioning of the code, making the project accessible to all, +irrespective of their level of expertise. +Our project thrives on the contributions from the community, +and improving the documentation is one of the significant ways you can contribute.
+Here are some ways you could help improve our documentation:
+Your contributions should follow the guidelines specified in our Style guides +section to maintain high quality and consistency. +Before making a substantial change, it's a good practice to open an issue to discuss the proposed changes or +find an existing issue to work on.
+Together, we can ensure that our documentation is a valuable resource for all new and experienced developers.
+For Rust, we follow the +Rust Style Guide.
+For Dart, we follow the +Effective Dart style guide.
+For Flutter, we follow the +Flutter Style Guide.
+Clear and consistent commit messages are crucial for maintaining a readable history in our collaborative environment. +Adhering to a structured commit message format also enables us to generate changelogs and +navigate through the project's history more efficiently. +We follow the Conventional Commits standard for all commit messages in this repository.
+Here's a brief overview of the Conventional Commits standard:
+Format:
+ +Example:
+feat(button): add a 'submit' button to form component
+fix(modal): resolve issue with modal overlay not closing
+chore(tests): update unit tests for utilities module
+
!
after the type.
+Include BREAKING CHANGE:
in the body or footer of the commit message to describe what changed and its implications.Example:
+feat!(dropdown): change the behavior of dropdown component
+BREAKING CHANGE: alters dropdown trigger to be activated on hover instead of on click.
+
Following this format makes the version control history readable and reflects professionalism and +foresight in maintaining a clean, well-documented codebase.
+ + + + + + + Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright (c) 2023 Input Output (IOG).
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+
Copyright (c) 2023 Input Output (IOG).
+
+ Permission is hereby granted, free of charge, to any
+ person obtaining a copy of this software and associated
+ documentation files (the "Software"), to deal in the
+ Software without restriction, including without
+ limitation the rights to use, copy, modify, merge,
+ publish, distribute, sublicense, and/or sell copies of
+ the Software, and to permit persons to whom the Software
+ is furnished to do so, subject to the following
+ conditions:
+
+ The above copyright notice and this permission notice
+ shall be included in all copies or substantial portions
+ of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+ TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+ PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+ SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+ IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+
Please report (suspected) security vulnerabilities to security@iohk.io. +You will receive a +response from us within 48 hours. +If the issue is confirmed, we will release a patch as soon +as possible.
+Please provide a clear and concise description of the vulnerability, including:
+If you have developed any code or utilities that can help demonstrate the suspected +vulnerability, please mention them in your email but DO NOT attempt to include them as +attachments as this may cause your Email to be blocked by spam filters.
+ + + + + + +The appendix contains collections of extra information and examples relevant to Hermes.
+ + + + + + +... ~Diagram or Table~
+... ~optionally: Explanation of external domain interfaces~
+... ~Diagram or Table~
+... ~optionally: Explanation of technical interfaces~
+... ~Mapping Input/Output to Channels~
+ + + + + + +... ~Overview Diagram~
+Motivation
+... ~text explanation~
Contained Building Blocks
+... ~Description of contained building block (black boxes)~
Important Interfaces
+... ~Description of important interfaces~
... Purpose/Responsibility
+... Interface(s)
+... ~(Optional) Quality/Performance Characteristics~
+... ~(Optional) Directory/File Location~
+... ~(Optional) Fulfilled Requirements~
+... ~(optional) Open Issues/Problems/Risks~
+... ~black box template~
+... ~black box template~
+…
+... ~white box template~
+... ~white box template~
+…
+... ~white box template~
+... ~white box template~
+... ~white box template~
+... ~white box template~
+ + + + + + +~insert runtime diagram or textual description of the scenario~
+~insert description of the notable aspects of the interactions + between the building block instances depicted in this diagram.~
+... ~Overview Diagram~
+Motivation
+... ~explanation in text form~
Quality and/or Performance Features
+... ~explanation in text form~
Mapping of Building Blocks to Infrastructure
+... ~description of the mapping~
... ~diagram + explanation~
+... ~diagram + explanation~
+…
+... ~diagram + explanation~
+ + + + + + +There needs to be a commonly understood and well documented structure to Architecture Documentation. +Architecture Documentation is the responsibility of the entire team. +A standardized structure to that documentation helps with collaboration.
+We will be using the arc42 standard for organizing architecture documentation.
+If we do:
+If we don't:
+Architecture Decision Records are part of arc42. +We need an efficient and automated way to manage them. +The system needs to be easy for anyone to use as documenting Architecture Decisions is a team responsibility.
+We will use the MkDocs Material ADR Plugin to assist in ADR documentation and automation.
+This risk can be mitigated because the plugin is simple, and it would be easy for us to fork and maintain it as required.
+Index
+graph TD
+0001-arch-std[0001 Architecture Documentation Standard]
+click 0001-arch-std "/hermes/architecture/09_architecture_decisions/0001-arch-std/" _blank
+0001-arch-std:::mermaid-accepted
+0001-arch-std:::mermaid-common
+0002-adr[0002 Architecture Decision Records]
+click 0002-adr "/hermes/architecture/09_architecture_decisions/0002-adr/" _blank
+0002-adr:::mermaid-accepted
+0002-adr:::mermaid-common
+0001-arch-std -- Extended --> 0002-adr
+classDef mermaid-draft fill:#a3a3a3;
+classDef mermaid-common color:#595959;
+classDef mermaid-proposed fill:#b6d8ff;
+classDef mermaid-common color:#595959;
+classDef mermaid-accepted fill:#b4eda0;
+classDef mermaid-common color:#595959;
+classDef mermaid-rejected fill:#ffd5d1;
+classDef mermaid-common color:#595959;
+classDef mermaid-superseded fill:#ffebb6;
+classDef mermaid-common color:#595959;
+
+
+
+
+
+
+ Term | +Definition | +
---|---|
Term-1 | +definition-1 | +
Term-2 | +definition-2 | +
The architecture documentation is based upon the Arc42 documentation standard.
+arc42, the template for documentation of software and system +architecture.
+Template Version 8.2 EN. (based upon AsciiDoc version), January 2023
+Created, maintained and © by Dr. +Peter Hruschka, Dr. +Gernot Starke and +contributors. +See https://arc42.org.
+ + + + + + +{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var Ha=/["'&<>]/;Un.exports=$a;function $a(e){var t=""+e,r=Ha.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i