hyperledger-identus · curtis-h · Feb 26, 2025 · Feb 12, 2025
@@ -1 +1 @@
-* @hyperledger/identus-maintainers
+* @hyperledger-identus/identus-maintainers
@@ -1,13 +1,13 @@
-# Contributing to Edge Agent SDK TS
+# Contributing to SDK TS
 
 :rocket::tada: First off, thanks for taking the time to contribute! :tada::rocket:
-The following guidelines are for contributing to Edge Agent SDK TS. These are mostly guidelines. Use your best judgment, and feel free to propose changes to this document in a pull request.
+The following guidelines are for contributing to Identus SDK TS. These are mostly guidelines. Use your best judgment, and feel free to propose changes to this document in a pull request.
 
 #### Table Of Contents
 
 [What should I know before I get started?](#what-should-i-know-before-i-get-started)
   * [Identus](#identus)
-  * [Edge Agent SDK TS](#edge-agent-sdk-ts)
+  * [SDK TS](#sdk-ts)
 
 [How Can I Contribute?](#how-can-i-contribute)
   * [Your First Code Contribution](#your-first-code-contribution)
@@ -26,18 +26,19 @@ The following guidelines are for contributing to Edge Agent SDK TS. These are mo
 Identus is a self-sovereign identity (SSI) platform and service suite for verifiable data and digital identity. Built on Cardano, as a distributed ledger, it offers the core infrastructure for issuing DIDs (Decentralized identifiers) and verifiable credentials alongside tools and frameworks to help expand your ecosystem.
 The complete platform is separated into multiple repositories:
 
-* [Cloud Agent](https://github.com/hyperledger/identus-cloud-agent) - Repo that contains the cloud agent that provides self-sovereign identity services to build products and solutions.
-* [Mediator](https://github.com/input-output-hk/atala-prism-mediator) - Repo for the DIDComm V2 Mediator.
-* [Edge Agent SDK Swift](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift) - Repo for the Swift version of the SDK.
-* [Edge Agent SDK KMP](https://github.com/input-output-hk/atala-prism-wallet-sdk-kmm) - Repo for the Kotlin Multi-Platform version of the SDK.
+* [Cloud Agent](https://github.com/hyperledger-identus/cloud-agent) - Repo that contains the cloud agent that provides self-sovereign identity services to build products and solutions.
+* [Mediator](https://github.com/hyperledger-identus/mediator) - Repo for the DIDComm V2 Mediator.
+* [SDK Swift](https://github.com/hyperledger-identus/sdk-swift) - Repo for the Swift version of the SDK.
+* [SDK KMP](https://github.com/hyperledger-identus/sdk-kmp) - Repo for the Kotlin Multi-Platform version of the SDK.
 
-### Edge Agent SDK TS
 
-Edge Agent SDK TS software development kit will help adoption within TS platforms (Browser/Node) by providing key functionalities. For more information about the SDK, please have a look at the [Readme](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/master/README.md)
+### SDK TS
+
+The SDK TS will help adoption within TS platforms (Browser/Node) by providing key functionalities. For more information, please have a look at the [Readme](https://github.com/hyperledger-identus/sdk-ts/blob/main/README.md)
 
 ### Your First Code Contribution
 
-Unsure where to begin contributing to Edge Agent SDK TS? You can start by looking through the [Readme](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/master/README.md) that provides all the steps to setup your environment.
+Unsure where to begin contributing to the SDK? You can start by looking through the [Readme](https://github.com/hyperledger-identus/sdk-ts/blob/main/README.md) that provides all the steps to setup your environment.
 
 ### Commit Signing
 
@@ -76,33 +77,33 @@ Other resources:
 
 The process described here has several goals:
 
-- Maintain the SDK quality
+- Maintain the code quality
 - Fix problems that are important to users
 - Engage the community in working toward the best possible product
 - Enable a sustainable system for the SDK maintainers to review contributions
 
 Please follow these steps to have your contribution considered by the maintainers:
 
 1. Sign your commits (see [more info](#commit-signing))
-2. Follow all instructions in [the template](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
+2. Follow all instructions in [the template](https://github.com/hyperledger-identus/sdk-ts/blob/main/.github/PULL_REQUEST_TEMPLATE.md)
 3. Follow the [styleguides](#styleguides)
 4. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, we will open an issue to track that problem with our status check suite.</details>
 
 While the prerequisites above must be satisfied before your pull request is reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be accepted.
 
 ### Reporting Bugs
 
-This section guides you through submitting a bug report for Edge Agent SDK TS. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behaviour:computer: :computer:, and find related reports :mag_right:.
+This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behaviour:computer: :computer:, and find related reports :mag_right:.
 
-Before creating bug reports, please check [this list](#before-submitting-a-bug-report), as you might not need to create one. When creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/master/.github/ISSUE_TEMPLATE/1-bug-report.yaml), the information it asks for helps us resolve issues faster.
+Before creating bug reports, please check [this list](#before-submitting-a-bug-report), as you might not need to create one. When creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/hyperledger-identus/sdk-ts/blob/main/.github/ISSUE_TEMPLATE/1-bug-report.yaml), the information it asks for helps us resolve issues faster.
 
 > **Note:** If you find a **Closed** issue that seems like the same thing you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
 
 * **You might be able to find the cause of the problem and fix things yourself by Debugging**. Most importantly, check if you can reproduce the problem in the latest version.
-* **Check the [Readme](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/master/README.md) ** if you have problems with the setup and the [discussions](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/discussions)** for a list of common questions and problems.
+* **Check the [Readme](https://github.com/hyperledger-identus/sdk-ts/blob/main/README.md) ** if you have problems with the setup and the [discussions](https://github.com/hyperledger-identus/sdk-ts/discussions)** for a list of common questions and problems.
 * **Perform a cursory search to see if the problem has already been reported**. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
 
-Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information by filling in [the template](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/new/choose).
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information by filling in [the template](https://github.com/hyperledger-identus/sdk-ts/issues/new/choose).
 
 Explain the problem and include additional details to help maintainers reproduce the problem:
 
@@ -124,7 +125,7 @@ Provide more context by answering these questions:
 
 This section guides you through submitting an enhancement suggestion for the SDK, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
 
-Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion), as you might find out that you don't need to create one. When creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/blob/master/.github/ISSUE_TEMPLATE/2-feature-request.yaml), including the steps that you imagine you would take if the feature you're requesting existed.
+Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion), as you might find out that you don't need to create one. When creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/hyperledger-identus/sdk-ts/blob/main/.github/ISSUE_TEMPLATE/2-feature-request.yaml), including the steps that you imagine you would take if the feature you're requesting existed.
 
 * Most importantly, **check if you're using the latest version.** 
 * **Perform a cursory search** to see if the enhancement has already been suggested. If it has, comment on the existing issue instead of opening a new one.

@@ -1,3 +1,3 @@
 # Developer Certificate of Origin (DCO)
 
-For information about sign-offs required for contributions to this repository, please refer to this Hyperledger Identus repository's [DCO.md](https://github.com/hyperledger/identus/blob/main/DCO.md) file. 
+For information about sign-offs required for contributions to this repository, please refer to this Hyperledger Identus repository's [DCO.md](https://github.com/hyperledger-identus/identus/blob/main/DCO.md) file.
@@ -1,3 +1,3 @@
-# Mainteiners
+# Maintainers
 
-For information about the Maintainers of this repository, please see the Hyperledger Identus repository’s [MAINTAINERS.md](https://github.com/hyperledger/identus/blob/main/MAINTAINERS.md) file.
+For information about the Maintainers of this repository, please see the Hyperledger Identus repository’s [MAINTAINERS.md](https://github.com/hyperledger-identus/identus/blob/main/MAINTAINERS.md) file.
@@ -13,19 +13,18 @@ verifiable data and digital identity. Built on Cardano, as a distributed ledger,
 it offers core infrastructure for issuing DIDs (Decentralized identifiers) and 
 verifiable credentials, alongside tools and frameworks to help expand your ecosystem.
 The complete platform is separated into multiple repositories:
-* [Cloud Agent](https://github.com/hyperledger/identus-cloud-agent) - Repo that contains the Cloud Agent that provides self-sovereign identity services to build products and solutions.
-* [Mediator](https://github.com/input-output-hk/identus-prism-mediator) - Repo for the DIDComm V2 Mediator.
-* [Edge Agent SDK TS](https://github.com/hyperledger/identus-edge-agent-sdk-ts) - Repo for the Typescript version of the SDK.
+* [Cloud Agent](https://github.com/hyperledger-identus/cloud-agent) - Repo that contains the Cloud Agent that provides self-sovereign identity services to build products and solutions.
+* [Mediator](https://github.com/hyperledger-identus/mediator) - Repo for the DIDComm V2 Mediator.
+* [SDK TS](https://github.com/hyperledger-identus/sdk-ts) - Repo for the Typescript SDK.
 
-We also have edge agents for other platforms:
-* [Edge Agent SDK Swift](https://github.com/hyperledger/identus-edge-agent-sdk-swift) - Repo for the Swift version of the SDK.
-* [Edge Agent SDK KMP](https://github.com/hyperledger/identus-edge-agent-sdk-kmp) - Repo for the Kotlin Multi-Platform version of the SDK.
+We also have SDKs for other platforms:
+* [SDK Swift](https://github.com/hyperledger-identus/sdk-swift) - Repo for the Swift SDK.
+* [SDK KMP](https://github.com/hyperledger-identus/sdk-kmp) - Repo for the Kotlin Multi-Platform SDK.
 
 ## SDK Overview
 
 - Apollo: Provides a suite of necessary cryptographic operations.
 - Castor: Provides a suite of operations to create, manage and resolve decentralized identifiers.
-- Pollux: Provides a suite of operations for handling [verifiable credentials](https://github.com/hyperledger/identus-docs/blob/master/documentation/docs/concepts/glossary.md#verifiable-credentials).
 - Mercury: Provides a suite of operations for handling DIDComm V2 messages.
 - Pluto: Provides an interface for storage operations in a portable, storage-agnostic manner.
 - Agent: A component using all other building blocks, provides basic edge agent capabilities, including implementing DIDComm V2 protocols.
@@ -55,8 +54,8 @@ The demos assume building this repo from source, so you will need the following:
 
 Clone and build:
 ```bash
-git clone git@github.com:hyperledger/identus-edge-agent-sdk-ts.git --recurse-submodules
-cd identus-edge-agent-sdk-ts
+git clone git@github.com:hyperledger-identus/sdk-ts.git --recurse-submodules
+cd sdk-ts
 npm i
 npm run build
 ```
@@ -76,5 +75,3 @@ cd demos/next
 npm i
 npm run dev
 ```
-
-
@@ -1,3 +1,3 @@
 # Security 
 
-For information about reporting security vulnerabilities in this repository, please consult the Hyperledger Identus repository’s [SECURITY.md](https://github.com/hyperledger/identus/blob/main/SECURITY.md) file.
+For information about reporting security vulnerabilities in this repository, please consult the Hyperledger Identus repository’s [SECURITY.md](https://github.com/hyperledger-identus/identus/blob/main/SECURITY.md) file.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		* @hyperledger/identus-maintainers
		* @hyperledger-identus/identus-maintainers