- Go to the Iroha documentation and go through the "Building Iroha" guide
- Windows users, look into the https://github.com/hyperledger/iroha/pull/1988 description to get instructions how to build Iroha on your machine.
- Run the Iroha node by the command
./build/bin/irohad --config example/config.sample --keypair_name example/node0 --genesis_block example/genesis.block --overwrite_ledger
from the iroha
directory
- Login into the Github and fork the Iroha project from the http://github.com/hyperledger/iroha
- Create a branch for the changes, for example
feature/change_asset_regex
- Open the project in the convenient editor (VS Code, CLion, etc.) and go to the
shared_model/validators/field_validator.cpp
. Take a look on the code and find the place when you should change the pattern of the asset name. Our idea is to change the pattern that it should obey the "exactly 3 letters" rule (like usd
, jpy
, hkd
, etc.)
- Build Iroha again and be sure that building is successful
- Run the tests and check that many tests are broken because of using predefined asset name for the testing, which violates the new rule (and this asset name is defined in many places – a good point for the contribution!). Remember, that running PostgreSQL container is needed for several tests to be successful.
- Change the rule for "exactly 3 or 4 letters" and rebuild Iroha. Rerun the test to be sure that everything is going better.
- Run the iroha daemon locally using the
./build/bin/irohad --config example/config.sample --keypair_name example/node0 --genesis_block example/genesis.block --overwrite_ledger
command (from the iroha
folder)
- Check that everything works as expected using the CLI
- Commit your changes to your Github fork