Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Create README for custom transactions - Closes #3164 #3735

Merged
merged 15 commits into from
Jun 26, 2019

Conversation

MaciejBaj
Copy link
Contributor

@MaciejBaj MaciejBaj commented May 27, 2019

What was the problem?

Missing README.md file describing the custom transactions interface.

How did I fix it?

Included the explanation of:

  • what is a transaction
  • what is a custom transaction
  • custom transactions required interface

Review checklist

elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Show resolved Hide resolved
elements/lisk-transactions/README.md Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
@shuse2 shuse2 requested review from Tschakki and SargeKhan and removed request for Tschakki June 4, 2019 07:08
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Show resolved Hide resolved
Copy link
Contributor

@Tschakki Tschakki left a comment

Choose a reason for hiding this comment

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

Maybe the order of the methods can be improved to

  1. prepare
  2. validateAsset
  3. applyAsset
  4. undoAsset

analog to docs: https://github.com/LiskHQ/lisk-docs/blob/235-hello-world-app/custom-transactions.md

elements/lisk-transactions/README.md Show resolved Hide resolved
Correct the overview of `prepare` step

Co-Authored-By: Usman <[email protected]>
@shuse2 shuse2 requested a review from mitsuaki-u June 11, 2019 13:08
Copy link
Contributor

@mitsuaki-u mitsuaki-u left a comment

Choose a reason for hiding this comment

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

LGTM some minor suggestions

elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
elements/lisk-transactions/README.md Show resolved Hide resolved
elements/lisk-transactions/README.md Show resolved Hide resolved
@MaciejBaj MaciejBaj force-pushed the 3164-custom_transaction_readme branch 2 times, most recently from 0425ee1 to 92efe6f Compare June 17, 2019 15:15
@MaciejBaj MaciejBaj force-pushed the 3164-custom_transaction_readme branch from 92efe6f to c294c90 Compare June 17, 2019 15:16
@MaciejBaj MaciejBaj force-pushed the 3164-custom_transaction_readme branch from c294c90 to bf734f3 Compare June 17, 2019 15:18
Copy link
Contributor

@mitsuaki-u mitsuaki-u left a comment

Choose a reason for hiding this comment

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

LGTM besides the repeated sentence

elements/lisk-transactions/README.md Outdated Show resolved Hide resolved
@MaciejBaj MaciejBaj merged commit 5292a53 into release/2.1.0 Jun 26, 2019
@MaciejBaj MaciejBaj deleted the 3164-custom_transaction_readme branch June 26, 2019 06:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants