Skip to content

vitorbritto/workflow-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 

Repository files navigation


Workflow Guide

Workflow Guide



Summary
  1. Workflow Lifecycle
  2. Tools
  3. Tech Stack
  4. Guides
  5. Best Practices

Introduction

Hello there! I'm Vitor Britto, a Senior Software Engineer based in Brazil with over 15 years of experience in the software industry. I'm passionate about improving skills, learning new technologies, enjoy influencing others and always advocate for technical excellence while being open to change. I have strong experience building SaaS applications and developing software products.

🚀 Feel free to visit my personal website: https://vitorbritto.dev

About this Guide

  1. A personal Framework with approaches and methods that I use to delivery high-quality softwares.
  2. Tools that makes my Workflow easy.
  3. My own code conventions, which is inspired by what is popular within the community and flavored with some personal opinions.
  4. Major dependencies that I use.

The main reasons

  • Apply rules and be based on a principle and methodology of process which could maintain the structure of my standards.
  • Not only have a code style guide, but relevant informations about my Workflow. Thus I always keep the same logic process and can initiate the development of my projects without any questions when making a scaffolding, building process, automation rotines, unit testing and others tasks.

Workflow Lifecycle

You can find a complete list of applications, utilities, DevOps and Business Tools here: Stack Share

This is a simple table with approaches and methods that I use at my Workflow lifecycle.

Plan Design Develop Deploy
Research Concepting Scaffolding CI/CD
Observe Prototype Coding Testing
Understand Refine Build Monitoring
Analyze Style Guide QA Optimization
Timeline Approval Review Maintenance

[back to top]

Tools

Plan & Project Management

  • Notion - Documentation and knowledge base
  • Figma - Design and prototyping
  • Draw.io - System architecture diagrams

Communication & Collaboration

  • Slack - Team messaging and collaboration
  • Discord - Community and team communication
  • Google Meet - Video conferencing
  • Loom - Screen recording and async communication

Development Environment

Code Editors & IDEs

  • Zed - AI-powered code editor

Terminal & Shell

  • Warp - Terminal emulator for macOS

Version Control

  • Git - Version control system
  • GitHub - Code hosting and collaboration

[back to top]

Tech Stack

Frontend Development

Frameworks & Libraries

Styling & UI

State Management

Backend Development

Runtime & Frameworks

Database & ORM

Authentication & Security

Mobile Development

  • React Native - Cross-platform mobile development
  • Expo - React Native development platform
  • Ignite - React Native development platform

Testing

Unit & Integration Testing

E2E Testing

DevOps & Cloud

Cloud Platforms

  • Vercel - Deployment platform for Next.js
  • AWS - Cloud computing platform

Infrastructure & Deployment

Monitoring & Analytics

Development Tools

Build Tools & Bundlers

Package Managers

  • pnpm - Fast, disk space efficient package manager

Code Quality

[back to top]

Guides

For web projects in which I work from planning to delivery, I use the guides below. If I am on a team that already has established guides, I'll follow the rules already adopted. No bullshit, just follow the rules.

Project Management

  • [STRATEGY]: Kanban and/or Scrum method
  • [AGILE]: Shape Up methodology for product development
  • [PLANNING]: OKR framework for goal setting

Development Principles

Code Standards

Be Consistent

The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on what you're saying rather than on how you're saying it. We present global style rules here so people know the vocabulary, but local style is also important. If code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they go to read it. Avoid this.

[back to top]

Best Practices

Performance

Security

  • Always validate input data
  • Use HTTPS in production
  • Implement proper CORS policies
  • Sanitize user inputs
  • Use environment variables for sensitive data
  • Regular dependency updates

Accessibility

  • Follow WCAG 2.1 guidelines
  • Use semantic HTML elements
  • Provide alt text for images
  • Ensure keyboard navigation
  • Test with screen readers

SEO

  • Use next-seo for meta tags
  • Implement structured data
  • Optimize for Core Web Vitals
  • Use descriptive URLs
  • Create sitemaps

[back to top]

License

MIT License © Vitor Britto

About

📓 My workflow context and own code conventions

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •