Skip to content

Instantly share code, notes, and snippets.

@deniskyashif
Created December 11, 2018 09:58
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save deniskyashif/e67f8314c455c39959410bdb059f695c to your computer and use it in GitHub Desktop.
Save deniskyashif/e67f8314c455c39959410bdb059f695c to your computer and use it in GitHub Desktop.

This is the readme for the UDM Project


UDM.Global

This is the project used for the Global Domain entities

UDM.ETL

This is the project for the SQL Server Integration Services used to populate the PostgreSQL database

UDM.Api

This is the Api used to retrieve data from the PrevalentUDM and PrevalentVendorUDM databases

Development Guidelines

Coding Style

Check out the Prevalent Inc. C# Style Guide for detailed description. Clean all the code analysis warnings before making a commit.

Branch Naming Conventions

<type>/topic-of-my-work

Commit Message Conventions

Format of the commit message

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Message Header

Subject line contains succinct description of the change.

Allowed <type>

  • feat (feature)
  • fix
  • docs
  • style (formatting, missing smi colons etc.)
  • refactor
  • test (add or modify tests)
  • chore (maintain)

Allowed <scope>
Scope could be anything specifying place of the commit change. For example model, repository, service, infrastructure etc.

<subject> text
This is a very short description of the change.

  • use imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Message body

* just as in `<subject>` use imperative, present tense: "change" not "changed" nor "changes"
* includes motivation for the change and contrasts with previous behavior

Message footer

All breaking changes have to be mentioned in footer with the description of the change, justification and migration notes.
Closed bugs should be listed on a separate line in the footer prefixed with "Closes" keyword like this:

Closes #234

Examples

feat(service): wire up with the config service

- create an interface for comminucating with the config service
- include it as a service to the app DI container
- add a section in appsettings.json for storing values required to establish a connection to the config service

Closes #231
test(service): add unit tests for the config service client

- verify that the service client reads the settings from appsettings.json
- retry X amount of times if a connection to the config service fails

Closes #233
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment