code-conventions.md

Code Conventions & Best Practices

The purpose of this and related documents is to outline the established programming conventions for the various languages of this application.

Each language and framework are broken into their own child document.

• CSharp
• Dotnet
• React
• TypeScript

IDE Setup

For both frontend and backend development, the andculture team has preferred Visual Studio Code, since it is free, open source, cross-platform, and widely adopted.

Extensions

We use a few extensions available on the market place for language support, linting, formatting, and snippet generation. When you open the repository in VS Code, it should recommend the extensions listed in .vscode/extensions.json.

• ESLint
  • ESLint plugin for linting
• Prettier - Code formatter
  • Prettier plugin for formatting
• C# XML Documentation Comments
  • CSharp XML doc generation
• C#
  • CSharp plugin for language support, intellisense, etc
• TSLint
  • TSLint plugin for language support
• Debugger for Chrome
  • Enables attaching to Chrome processes for frontend debugging
• Trailing Spaces
  • Highlights & deletes trailing whitespace characters