hashgraph / hedera-services

Crypto, token, consensus, file, and smart contract services for the Hedera public ledger
Apache License 2.0
299 stars 137 forks source link

Rename Versioned.getVersion() to getClassVersion() #5226

Open swirlds-automation opened 1 year ago

swirlds-automation commented 1 year ago

πŸ†•πŸ₯ First Timers Only

This issue is reserved for people who have never contributed to Hedera or any open source project in general. We know that creating a pull request (PR) is a major barrier for new contributors. The goal of this issue and all other issues labeled by 'good first issue' is to help you make your first contribution to Hedera.

πŸ‘Ύ Description of the issue

The interface com.swirlds.common.io.Versioned is used in the serialization api. It has a method int getVersion() that defines a version of a concrete class for serialization. Since the method name getVersion() often collide with downstream naming schemas (like if another interface or abstract class provides a getVersion() method) it should be renamed to getClassVersion().

Proposed Solution:

Refactor the int getVersion() method to int getClassVersion().

πŸ“‹ Step by step guide to do a contribution

If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file. A more detailed general documentation of the GitHub PR workflow can be found here.

πŸŽ‰ Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽

πŸ€” Additional Information

If you have any questions, just ask us directly in this issue by adding a comment. You can join our community chat at Discord. A general manual about open-source contributions can be found here.

Ndacyayisenga-droid commented 6 days ago

@hendrikebbers can I take up this issue?