Introduction

This repo holds common interfaces that are consumed by all LMD solutions

Getting Started

1. ##Setup the .npmrc file Setting up the .npmrc file will allow you to pull lmddefs dependency from the Azure Artifacts

   1. Go to Artifacts
   2. Click lmddefs
   3. Click Connect to feed
   4. Click npm
   5. Click Other
   6. Follow the Project setup instructions (4 steps)

Info: In case you want to setup the .npmrc file only once globally so that it is taken into account for all projects, please follow the instructions of this guide.

2. Installation process
3. Software dependencies
4. Latest releases
5. API references

Making changes and publishing

When updates are done to the code in this repo they must be,

1. commited git commit -m [message]

There shall be no uncommited changes left if continuing to step 2

2. version bumped with npm version [major|minor|patch]

Running this command will bump the package version, create a new git tag, push the changes along with the tags and publish the module automatically

###How to decide whether a version bump is major, minor or patch?

• If the updates are modifications to existing code only then use npm version patch
• If the updates add new code then use npm version minor
• Chances are that we never have to use npm version major for this repo so DO NOT USE IT

Learn more about semantic versioning

If updates are not published they will not be available to those who consume lmddefs via the private registry

##Please, only publish from a clean main branch

Troubleshooting

git command not found

You must have git installed to run the npm version command sucessfully. https://git-scm.com/downloads

Contribute

TODO: Explain how other users and developers can contribute to make your code better.

If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files:

• ASP.NET Core
• Visual Studio Code
• Chakra Core