Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.46 KB

README.md

File metadata and controls

31 lines (25 loc) · 1.46 KB

Selego Style Guide

Introduction

This guide provides standards and best practices for developing projects at Selego, ensuring consistency, readability, and maintainability of our code.

Purpose

To establish a consistent coding style and workflow for all projects, making collaboration easier and reducing technical debt.

Why It's Important to Converge to the Same Tech

  • Consistency: Code should look like it was written by a single person.
  • Quality: It's better to be consistently BAD than non-consistently GOOD.
  • Adaptation: If you disagree with something in the whitepaper, write a message in #whitepaper channel in slack.

Audience

All Selego developers working on 0 to 1 projects or scale-ups.

Scope

This guide covers repository structure, branching strategy, commit messages, pull requests, code reviews, coding standards, issue tracking, documentation, automation, security, and best practices, specifically tailored for MERN stack, React Native.

Table of Contents

  1. Repository Structure
  2. Branching Strategy
  3. Commit Messages
  4. Pull Requests
  5. Code Reviews
  6. Coding Standards
  7. Best Practices
  8. Hosting
  9. Startup Toolkit
  10. Security
  11. Documentation