Draft
Conversation
Signed-off-by: Hendrik Ebbers <hendrik.ebbers@web.de>
jjohannes
added a commit
to hiero-ledger/hiero-gradle-conventions
that referenced
this pull request
Nov 22, 2024
This PR updates the license headers as defined in hiero-ledger/hiero#26 It updates: - The headers in the files in this repository - The header spotless rules to update the headers in the repositories that are going to use these plugins Signed-off-by: Jendrik Johannes <jendrik.johannes@gmail.com>
jjohannes
added a commit
to hiero-ledger/hiero-gradle-conventions
that referenced
this pull request
Nov 22, 2024
This PR updates the license headers as defined in hiero-ledger/hiero#26 It updates: - The headers in the files in this repository - The header spotless rules to update the headers in the repositories that are going to use these plugins Signed-off-by: Jendrik Johannes <jendrik.johannes@gmail.com>
jjohannes
added a commit
to hiero-ledger/hiero-gradle-conventions
that referenced
this pull request
Nov 22, 2024
This PR updates the license headers as defined in hiero-ledger/hiero#26 It updates: - The headers in the files in this repository - The header spotless rules to update the headers in the repositories that are going to use these plugins Signed-off-by: Jendrik Johannes <jendrik.johannes@gmail.com>
jjohannes
added a commit
to hiero-ledger/hiero-gradle-conventions
that referenced
this pull request
Nov 22, 2024
This PR updates the license headers as defined in hiero-ledger/hiero#26 It updates: - The headers in the files in this repository - The header spotless rules to update the headers in the repositories that are going to use these plugins Signed-off-by: Jendrik Johannes <jendrik.johannes@gmail.com>
rbarker-dev
requested changes
Nov 22, 2024
hashgraph-transfer.md
Outdated
Comment on lines
128
to
161
| ### Naming conventions for moving from "Hedera" to "Hiero" | ||
|
|
||
| When a repository is transfered the next big step is to remove "Hedera" from the code and documentation to make clear that the source is not only Hedera specific but can be used with any Hiero based network. | ||
| While a lot of this is a simple find and replace of "Hedera" in the docs (or class names, packages,...) there are some points on that we still need to use Hedera. | ||
|
|
||
| - Whenever "Hedera testnet" or "Hedera mainnet" is used it should not be changed. There is not "Hiero testnet" or "Hiero mainnet". | ||
| - Whenever "testnet" or "mainnet" is used we need to change it to "Hedera testnet" or "Hedera mainnet". For a Hedera specific project is it clear what "mainnet" or "testnet" is but in the Hiero context that could be anything. Here we need to make clear that we refer to the Hedera networks. | ||
| - If a project / repository is mentioned that has already been transfered to Hiero we should change the name and link to Hiero. As en example "hedera-sdk-go" will become "hiero-sdk-go" and "https://github.com/hashgraph/hedera-sdk-go" will become "https://github.com/hiero-ledger/hiero-sdk-go". | ||
| - If a project / repository has not been migrated to Hiero the name and link should not be changed. Here it would make sense to create an issue per repository and label it by "Hiero Transfer" for collecting such names for a later refactoring. | ||
|
|
||
| ### New license headers | ||
|
|
||
| When a repository is transfered we need to change the license headers of all (code) files in the repository. The new license header format has been discussed [here](https://github.com/hiero-ledger/tsc/issues/64). The new header looks like this: `// SPDX-License-Identifier: Apache-2.0`. A PR that does the change for the GO SDK can be found [here](https://github.com/hiero-ledger/hiero-sdk-go/pull/1152). | ||
|
|
||
| ### Appendix of README | ||
|
|
||
| We have defined a general text for some topics that should be in the README of every project: | ||
|
|
||
| ```markdown | ||
| ## Contributing | ||
|
|
||
| Whether you’re fixing bugs, enhancing features, or improving documentation, your contributions are important — let’s build something great together! | ||
|
|
||
| Please read our [contributing guide](https://github.com/hiero-ledger/.github/blob/main/CONTRIBUTING.md) to see how you can get involved. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Hiero uses the Linux Foundation Decentralised Trust [Code of Conduct](https://www.lfdecentralizedtrust.org/code-of-conduct). | ||
|
|
||
| ## License | ||
|
|
||
| [Apache License 2.0](LICENSE) | ||
| ``` | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| ### Naming conventions for moving from "Hedera" to "Hiero" | |
| When a repository is transfered the next big step is to remove "Hedera" from the code and documentation to make clear that the source is not only Hedera specific but can be used with any Hiero based network. | |
| While a lot of this is a simple find and replace of "Hedera" in the docs (or class names, packages,...) there are some points on that we still need to use Hedera. | |
| - Whenever "Hedera testnet" or "Hedera mainnet" is used it should not be changed. There is not "Hiero testnet" or "Hiero mainnet". | |
| - Whenever "testnet" or "mainnet" is used we need to change it to "Hedera testnet" or "Hedera mainnet". For a Hedera specific project is it clear what "mainnet" or "testnet" is but in the Hiero context that could be anything. Here we need to make clear that we refer to the Hedera networks. | |
| - If a project / repository is mentioned that has already been transfered to Hiero we should change the name and link to Hiero. As en example "hedera-sdk-go" will become "hiero-sdk-go" and "https://github.com/hashgraph/hedera-sdk-go" will become "https://github.com/hiero-ledger/hiero-sdk-go". | |
| - If a project / repository has not been migrated to Hiero the name and link should not be changed. Here it would make sense to create an issue per repository and label it by "Hiero Transfer" for collecting such names for a later refactoring. | |
| ### New license headers | |
| When a repository is transfered we need to change the license headers of all (code) files in the repository. The new license header format has been discussed [here](https://github.com/hiero-ledger/tsc/issues/64). The new header looks like this: `// SPDX-License-Identifier: Apache-2.0`. A PR that does the change for the GO SDK can be found [here](https://github.com/hiero-ledger/hiero-sdk-go/pull/1152). | |
| ### Appendix of README | |
| We have defined a general text for some topics that should be in the README of every project: | |
| ```markdown | |
| ## Contributing | |
| Whether you’re fixing bugs, enhancing features, or improving documentation, your contributions are important — let’s build something great together! | |
| Please read our [contributing guide](https://github.com/hiero-ledger/.github/blob/main/CONTRIBUTING.md) to see how you can get involved. | |
| ## Code of Conduct | |
| Hiero uses the Linux Foundation Decentralised Trust [Code of Conduct](https://www.lfdecentralizedtrust.org/code-of-conduct). | |
| ## License | |
| [Apache License 2.0](LICENSE) | |
| ``` |
I think all of this should go in a different document. The content described here does not really relate to the transfer steps that are defined in this document.
I recommend adding a post-transfer readme file for the repository maintainers to utilize
Co-authored-by: Roger Barker <roger.barker@swirldslabs.com> Signed-off-by: Hendrik Ebbers <hendrik.ebbers@web.de>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added some information of Post-Transfer work