Skip to content

Fixes and Improvements#3

Open
FarzeenKist wants to merge 1 commit into0xOlivanode:mainfrom
FarzeenKist:improvement
Open

Fixes and Improvements#3
FarzeenKist wants to merge 1 commit into0xOlivanode:mainfrom
FarzeenKist:improvement

Conversation

@FarzeenKist
Copy link

  • Fix typos across the tutorial
  • Fix some grammar and punctuation
  • Fix the issue of using decimal numbers in the example smart contract which was causing compiling issues
  • Apply the concept of basis points to work with percentages in the smart contract and adjusted codebase
  • Add a note that helps users to find the code for the AggregatorV3 Interface
  • Add configure settings for Hardhat in the deployment section to make it easy for readers to quickly set up Hardhat for the Alfajores testnet.
  • Add the requirements section to let users know what tools they should have to follow the tutorial smoothly
  • Add a pre-requisites section to allow users to know what they should know to be able to follow the tutorial without any issues
  • Fix the title of the tutorial for best practices
  • Add links and references to technologies or concepts mentioned in the tutorial
  • Improve documentation of both smart contract
  • Add a modifier that ensures the arguments for the amount parameter are valid values
  • Indented the code snippets in the Setting Up Your Development Environment explanation to improve readability.
  • Modified the command that installs Hardhat to install Hardhat as a development dependency. It is unnecessary to install Hardhat as a global package.

Observations

  • Currently, no ChainLink data feed is available on the Alfajores testnet. I would suggest you switch to another Oracle that supports the Celo blockchain(such as Witnet) to make it easy for users to test the smart contracts on the Celo blockchain
  • I would suggest further explanations of the principle and logic used in the _calculateStability function as currently it's a bit confusing.

- Fix typos across the tutorial
- Fix some grammar and punctuation
- Fix the issue of using decimal numbers in the example smart contract which was causing compiling issues
- Apply the concept of basis points to work with percentages in the smart contract and adjusted codebase
- Add a note that helps users to find the code for the AggregatorV3 Interface
- Add configure settings for Hardhat in the deployment section
- Add the requirements section to let users know what tools they should have to follow the tutorial smoothly
- Add a pre-requisites section to allow users to know what they should know to be able to follow the tutorial without any issues
- Fix the title of the tutorial for best practices
- Add links and references to technologies or concepts mentioned in the tutorial
- Improve documentation of both smart contract
- Add a modifier that ensures the arguments for the `amount` parameter are valid values
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments