Skip to content

Development Guide

Jump to bottom
John Lambert edited this page Dec 12, 2024 · 4 revisions

The following are the coding guidelines for development for Serval (and for the NLP team in general).

  • For setting up your development environment, please look at the README.

  • Follow the Environment setup:

  • Configure VSCode to have all recommended extensions Builds should be successful without any warnings (it will crash the Try to resolve all spelling issues by adding new entries into the settings.json if necessary.

  • These abbreviations are valid: https://github.com/abbrcode/abbreviations-in-code

CSharpier

All C# code should be formatted using CSharpier. The best way to enable support for CSharpier is to install the appropriate IDE extension and configure it to format on save.

Coding conventions

Here is a good overview of naming conventions. Here is a good overview of coding conventions. If you want to get in to even more detail, check out the Framework design guidelines.

Clone this wiki locally