Code Monkey home page Code Monkey logo

handbook_best_practice's Introduction

Handbook_Best_Practice

The purpose of this handbook is to provide guidelines for software quality best practices within our small, fast-moving startup. With 20 software engineers working independently, there has been unpredictable progress with projects and many defects making it into production. This handbook will serve as a resource for existing and new team members to learn the "right way" of doing things in our company. The handbook will cover the following topics: Task estimation in Scrum, Code reviews, and a third topic of our choosing based on our research.


Structure of this Read Me

  1. Task Estimation in Scrum :

a. Break tasks down into smaller, more manageable pieces to accurately estimate effort required.

b. Use Planning Poker or similar techniques to facilitate group discussion and decision-making.

c. Consider the impact of dependencies and potential risks when estimating tasks.

d. Review and revise task estimates regularly, particularly when new information becomes available.

e. Identify and mitigate potential blockers or obstacles that may impact task completion.

  1. Code Review :

a. Review code regularly and frequently to catch issues early and provide timely feedback.

b. Establish clear guidelines and standards for code formatting, documentation, and style.

c. Encourage peer review and collaboration to promote learning and knowledge sharing.

d. Use tools and automation to support the review process and identify potential issues.

e. Provide constructive feedback that is specific, actionable, and respectful.

  1. Automated testing :

a. Write tests early and often to ensure coverage and catch issues early in the development process.

b. Use a variety of testing types, including unit, integration, and end-to-end testing, to ensure comprehensive coverage.

c. Use tools and frameworks to support testing, such as Selenium for web applications or Appium for mobile applications.

d. Continuously monitor and evaluate test results to identify potential issues and areas for improvement.

e. Integrate testing into the development process as a standard practice, rather than as an afterthought.

handbook_best_practice's People

Contributors

eliotools avatar s1mpletek avatar thanaelfontaine avatar quentinnicolas avatar

Watchers

 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.