Git Product home page Git Product logo

codereviews's Introduction

Code Reviews

I'm offering reviews for free and open source projects.

The reviews will focus on API design and general architection of your project with a view to making them a) more maintainable b) future proof and c) user friendly, but will avoid anything that a linter could do for you. Reviews are intended to be constructive and hopefully give advice you can act on, but are in no way a "grade".

I won't need to run your code to do a review and reviews aren't intended to fix bugs.

All reviews will be public and will be published in the repo in a markdown file. An exception would be for any security issues, where I would notify you first.

What projects can request a review?

Any Python project that is free and open source may request a review, but it must not be commercially backed i.e. full-time paid developers. Commercial sponsorship via GitHub sponsors or other is fine.

There's no size limit for a code review, but for free code reviews I can't realistically review very large projects. If you project is large, you might want to ask me to focus on a given area. What is large in this context, is not yet well defined.

Who can benefit from a review

I would expect small to medium sized projects with a single or small number of contributors would gain the most benefit from a review. Especially, if the project is in a stage where it is able to make potential architectural changes. Larger, more mature, projects with many contributors may not be in a position to affect the changes I reccomend!

Requesting a review

To request a review, open an Issue in this repository.

How long will a review take?

It depends on the backlog, but I'm hoping most reviews can be done in a week or two.

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.