README - Standard Dot

What this repository is for

Basic .NET Standard Libraries

This repository is for basic code that can be imported into any .NET Standard compatible project.

Licenses

MIT License

Usage

Documentation

There is a significant amount of inline documentation. In addition these readme's should give a general overview of each subsection.

Nuget

All packages generated here will be deployed to nuget and can be implemented by add them to your project.

Report Issues and Request Features

If you have any features you'd like to request, problems you have found, or questions open an issue

Other READMEs

• Stack Basics
• Learn Markdown
• Markdown Cheatsheet

How to get set up

Summary of set up

• Read through the whole readme here, and read the other readme's as needed
• Check the Stack Basics for setup if you are new

Configuration

• You need the .NET Core SDK

How to run tests

• The tests are included in the project and use XUnit
• To run the tests you'll need support for .sh files (usually bash) and docker/docker-compose installed and available from the PATH
• To run them do the following from the root directory

1. cd src
2. ./run-tests.sh

Deployment instructions

• You can find all of the StandardDot packages on nuget.org
• The goal is to have a readme for each project that will give general instructions for usage on each project
• This project is built and tested automatically by Azure DevOps and SonarQube

Contribution guidelines

• Writing tests
  • We use XUnit
  • We are aiming for >90% code coverage, so basically all code should have accompanying test
• Code review
  • All pull requests will need to be reviewed by an admin
• You can find results of testing and code quality analysis on SonarQube
• To get code to develop or master there must a pull request (Which can only be accepted by an admin)