Skip to content

Developer guidelines

Håvard Moås edited this page Aug 23, 2021 · 12 revisions

Developer guidelines

Branch policies

master is our default branch. It is protected and every commit has to be a part of a pull request in order for it to be merged. A pull request will trigger a Azure pipeline build that will build and run tests. It will also need a approval from a reviewer.

Releasing nuget packages

Starting a releasing is done by tagging.

Release

  • In Github, draft a new release
  • Tag version: v<major>.<minor>.<patch>. i.e: v1.0.0
  • Target branch: master
  • Write some nice change log notes.
  • Tap publish release

Pre-release

  • In Github, draft a new release
  • Tag version: v<major>.<minor>.<patch>-pre<incrementingNumber>. i.e: v1.0.0-pre001
  • Target branch: <your-branch>
  • Write some nice change log notes.
  • Check: This is a pre-release
  • Tap publish release

This branch has to be a branch that is not forked, so if you have a PR that you want to release as pre-release, please ask the team to create a branch of it.

This will trigger a Azure pipeline build that will create a .nupkg and publish it as a artifact. A release pipeline build will trigger and publish the nuget package here.

Public contributions

A fork has to be used when contributing to this repository.

Adding new functionality

When adding new UI components you should:

  • Add the code for the new functionality to a suiting namespace.
  • Make sure that namespace is a part of our our XmlnsDefinitions
  • Comment all public properties. (CI build will break if you don't)
  • Add an sample in the samples app.
    • Follow the same namespace that you added the code to.

Contact a team-member if you need any guideance. 👍