Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

62 lines (48 loc) · 1.98 KB

Contributing to DataModel

Commit Message Guidelines

Commit message guidelines are meant to mirror the style prescribed in Conventional Commits. Changes to the types and scope have been made.

Commit messages should follow the format:

<type>[optional scope]: <description>
[optional body]
[optional footer]

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • revert: Reverts commit <hash>.
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Scope

*Describe how scope is defined in the context of contributing to this project.

Example:

Examples here.

Subject

The subject contains a succinct description of the change:

  • Use the imperative, present tense
  • Don't capitalize the first letter
  • Don't include punctuation

Body

The body contains the detail of why the change was made:

  • Use the imperative, present tense
  • Include the motivation for the change with contrast to prior behavior

Footer

The footer contains information on breaking changes. Start with the phrase BREAKING CHANGE:. Also use this space to reference closing GitHub issues.

Example:

BREAKING CHANGE: Ends support for [NAME] API

Resolves #42 (where #42 is the GitHub issue no.)

Object Naming Conventions

This project uses naming conventions described in C# Coding Conventions | Microsoft.