Skip to content

Commit

Permalink
docs: update README and add quality assurance section
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremylgn committed Oct 2, 2023
1 parent 276cf9a commit 34ac829
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
This repository hosts Smart Contracts that are deployed on the [OKP4 network](http://okp4.network). But they are compatible with any
[Cosmos blockchains](https://cosmos.network/) that uses the [CosmWasm](https://cosmwasm.com/) framework.

## 🗄️ Storage oriented Smart Contracts
### 🗄️ Storage oriented Smart Contracts

<table>
<tr>
Expand Down Expand Up @@ -50,7 +50,7 @@ This repository hosts Smart Contracts that are deployed on the [OKP4 network](ht
</tr>
</table>

## ⚖️ Sovereignty oriented Smart Contracts
### ⚖️ Sovereignty oriented Smart Contracts

<table>
<tr>
Expand Down Expand Up @@ -174,7 +174,9 @@ The list of available tasks for managing the chain is as follows:
- `chain-start` - Run the full node okp4d application using the chain's home directory under a Docker container.
- `chain-stop` - Stop the chain's container.

## 🚀 Initialize the chain
## 💻 Develop

### 🚀 Initialize the chain

To initialize the chain, just run:

Expand Down Expand Up @@ -251,8 +253,6 @@ cargo make chain-clean
⚠️ Please be cautious when running this command as it will completely clean the chain's home directory and the action is
irreversible.

## 💻 Develop

### 🏗 Smart Contracts scaffolding

When developing a new Smart Contract, you can use the scaffolding to generate the Smart Contract's code.
Expand Down Expand Up @@ -312,6 +312,14 @@ documentation and commit the changes:
git commit -am "docs: update generated documentation"
```

## 🍀 Quality assurance approach

⛓ - The enforcement of stringent rules, monitored by a linter (Clippy) within the Github CI environment.

🤖 - A high level of code coverage through systematic unit testing.

💫 - Future considerations for additional testing approaches, such as fuzzy testing or end-to-end testing, to further enhance quality.

## 📘 Resources

- [CosmWasm Docs](https://docs.cosmwasm.com/)
Expand Down

0 comments on commit 34ac829

Please sign in to comment.