Git Product home page Git Product logo

solidity-review-process's Introduction

solidity-review-process

Solidity Code Review Process - An clear and repeatable process for reviewing Solidity code ๐Ÿ”

Introduction

This repo provides a clear visual process to reviewing Solidity code in the wild. This process has been designed to be repeatable and focuses on clear instructions over complex systems and methodologies. The guidelines found here a culmination of several developers in the web3 and crypto space and is open for community input. Our "Solidity Code Review Process" should be followed for those developers that are trying to understand what to look for first when reviewing Solidity or a Smart contract.

This process was originally created by me (@shepardcodes) to help my fellow developers stay busy with other things.

Wait, not just use a static analyzer, a linter, or just read the fu*king code?

Static analyzers are looking for security vuls, Linters are looking for coding patterns and reading the code can just suck and not provide a logical starting point. For these reasons, we created this project and this repo.

Questions or Feedback?

Don't agree with a portion of the review process? Want to be a contributor and help other Solidity developers? The status below will help indicate to the public what the status of the project is.

Feel free to open an Issue under our github project here:

Roadmap

Roadmap Item Date to Reach (Month) Released
Publish Repo 2022-10-09 โœ”
Finish Readme.md Intro for project 2022-11 โœ–
Upload original Solidity Code Review Paths 2022-11 โœ–
Fill out first logical paths 2022-12 โœ–

Code of Conduct

Community members and developers must all adhere to our general Code Of Conduct as they interact with each other. Please report any brenching of our Code Of Coduct policy to [email protected] or via Twitter @ShepardCodes.

License

MIT License

Copyright (c) 2022 Aratum Labs

solidity-review-process's People

Contributors

shepardcodes avatar

Stargazers

 avatar

Watchers

 avatar

solidity-review-process's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.