Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update hashgraph-transfer.md #26

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update hashgraph-transfer.md #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions hashgraph-transfer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,40 @@ At this point the repository is considered **transferred**.
- After the repository is transferred the [@hashgraph/devops-ci team][devops-ci] will deprecate existing packages
in the Hashgraph namespaces for Maven Central, NPMJS, and Gradle Plugin Central as applicable

### 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)
```

Comment on lines +128 to +161
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

[hiero]:https://github.com/hiero-ledger
[hashgraph]:https://github.com/hashgraph
[governance]:https://github.com/hiero-ledger/governance
Expand Down