Getting Started

Who is this document for#

The wiki section “Engineering” contains both coding standards, guidances and best practices for engineering team of The Software Practice. While this is useful for all engineers in the company, it would be overwhelming for juniors, interns or anyone who just starts in a new tech stack.

This document “Getting Started” aims to list down most basic, important documents in Engineering section. The target is to let anyone new to a tech stack or a language has something to read and pick up the new knowledge within the first 4-6 weeks. Beyond that, user can study the rest of the documents or do research by themselves.

• Please keep the list beginner-friendly and can be consumed as introduction materials for a project. The aim is to let the reader become more comfortable with the tech stack/language and make less mistake when starting to contribute to the code base.
• Please ensure each list is beginner-friendly enough to be consumed within 1 month or less.
• Please avoid adding content that easy to Google or already been well-documented elsewhere. Things like “Instruction to integrate Stripe payment” doesn’t need to be a document in our wiki, but an external link should suffice.

Recommendations#

General#

• Naming Conventions
• Capitalization Conventions

Git#

• Getting Started with GitLab
• Git Commits
• Git Merge Requests/Pull Requests

SQL#

C#/DotNet#

• Getting Started with C# .NET
• All documents under sections C#/.Net - Coding Standards

Java/Spring Boot#

Frontend - CSS#

• Learning Flex and Learning Grid via games

• BEM - Class Naming Conventional

Frontend - JavaScript/TypeScript#

Frontend - Vue#

• Getting Started with Vue