Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md (emojis + quality section) #341

Closed
2 tasks done
ccamel opened this issue Aug 30, 2023 · 1 comment
Closed
2 tasks done

Improve README.md (emojis + quality section) #341

ccamel opened this issue Aug 30, 2023 · 1 comment
Assignees

Comments

@ccamel
Copy link
Member

ccamel commented Aug 30, 2023

Purpose

The README.md file could be enhanced in the following ways:

  • Emojis are used for some section headers, but not all. It would be beneficial to add emojis to the remaining section titles for consistency.

image

  • A section should be added to describe the quality assurance approach used in this project, which ensures that the Smart Contracts developed meet high-quality standards. The section should especially mention that this is achieved through:
    • 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.
@AnjaMis AnjaMis moved this to 📋 Backlog in 💻 Development Sep 29, 2023
@AnjaMis AnjaMis moved this from 📋 Backlog to 📆 To do in 💻 Development Sep 29, 2023
@jeremylgn
Copy link
Contributor

#384 ☑️

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

No branches or pull requests

2 participants