Git Product home page Git Product logo

sourse-code-quality's Introduction

Clean Code related tasks for skills improvements. Tasks were divided into groups:

  • basic
  • advanced

Basic

Tasks are to refactor everything you think looks strange/unclear/has code smells, according to main clean code principles. During refactoring take attention to:

  • naming
  • functions
  • comments
  • formatting
  • classes and objects

Recommended refactoring time - up to 4h

Advanced

Simple project with code smells and bad practices usage to be refactored. Taken as assumption that during refactoring you will go according clean code related principles, practices and refactoring techniques. Anti patterns used in project should be avoided and replaced best practices. For more details check readme under appropriate module please.

Recommended refactoring time - up to 4h

DOD

Definition of done (DOD) for each task described separately, in each sub module(basic/advanced), but overall common rules are next

  • Code inspection results (default Intellij Idea inspection profile). Zero or close to it warnings amount. The less warnings - the better(Java Doc related warnings can be omitted and not taken into account, you can disable it)
  • Sonar Lint inspection. Same rules -zero or near to it issues amount is best.
  • Unit tests. All existing tests should be with positive results. Adding new tests - additional plus.

sourse-code-quality's People

Watchers

 avatar  avatar

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.