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

Add Comments to Clarify Code Examples (Insecure, Recommended, Secure) #37

Open
techvoyagerX opened this issue Sep 2, 2024 · 2 comments

Comments

@techvoyagerX
Copy link

The current codebase includes examples of insecure, recommended, and secure code patterns for various Sealevel attacks. However, these examples lack comments that clearly identify which code sections are insecure, recommended, or secure. This issue proposes adding detailed comments to each program to help developers easily understand and differentiate between these patterns. This will enhance the educational value of the repository and prevent potential confusion.

@techvoyagerX
Copy link
Author

I have created a PR that adds comments to the 0-signer-authorization program. The comments clearly identify the insecure, recommended, and secure code patterns in the examples. You can find the PR here: #38.

@techvoyagerX
Copy link
Author

I've added detailed comments to all programs and submitted pull requests. These comments clearly highlight insecure, recommended, and secure code patterns within the examples, contributing to the educational value of this repository.

Best!

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

1 participant