Developer guidelines

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

Starting a releasing is done by tagging.

• Tag the master branch with the following patterns
  • Pre-release: v<major>.<minor>.<patch>-pre<incrementingNumber>. i.e: v1.0.0-pre001
  • Release: v<major>.<minor>.<patch>. i.e: v1.0.0

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 UI components

When adding new UI components you should:

• Add the code for the new UI component to a suiting namespace.
• Comment all public properties. (Build will break if you don't)
• When creating it, add an sample in the samples app.
  • Follow the same namespace that you added the code to.

When it's merged:

• Add a wiki post and add a link to it it in the sidebar.
• If you are not a part of our internal team: Clone the wiki : https://github.com/DIPSAS/DIPS.Xamarin.UI.wiki.git