Contributing

If you have reached this page you have taken the first step as a contributor and we thank you for your interest in our Open Source project.

Before going any further here are some key aspects of how we operate and the principles we apply.

 

We are Agile – as project maintainers we work in Kanban a lean method to manage and improve work across human systems. This approach helps to manage work by balancing the demands with available capacity, and improving the handling of bottlenecks.

 

We follow a streamlined development process from plan through to deploy that enables a continuous integrated flow and continuous feedback to continually enhance and improve.

Continuous Integration and Continuous delivery

 

We apply the use of semantic versioning that uses a three-part number, MAJOR.MINOR.PATCH. Each of the parts is incremented as follows:

  • MAJOR, when a change is API-incompatible with previous releases
  • MINOR, when new functionality is added in a backwards-compatible manner
  • PATCH, when bug fixes are made in a backward-compatible manner

Semantic versioning provides a shared indication for library authors and users to communicate with each other.

 

All pull requests undergo peer review to ensure a consistent and high quality code base, combined with automated testing to ensure no breaking changes make it out in each release, as well as automated security checks to validate changes can be merged to the master branch of the source code. 

 

Our release train is on a continuous cycle, with new versions of components, new features, patches, or bug fixes tested and shipped for deployment. Release notes are provided with each release to ensure the recipient knows what they are getting and what they are installing.

 

There are 3 distinct .Stat Suite delivery mechanisms being put in place:

.Stat As a Service


.Stat Suite as a service: no technical skills required, limited configuration possible, and subscription costs for cloud service provisioning and maintenance required.


As Containers


.Stat Suite as containers: requires knowledge of docker (open source container technology) and orchestration, as well as deployment, maintenance or continuity of service is the receiving organisation’s responsibility.


As a Codebase


.Stat Suite as a codebase: requires a technical knowledge of the underlying ecosystems (.Net, JavaScript, SQL etc.), with Continuous Integration being the receiving organisation’s responsibility.


What next?

If you would like to get involved as an early contributor to the .Stat Suite open source project then please visit our Gitlab documentation pages where you’ll find information to help you get started, an overview of the architecture and different services, the Community code of conduct, as well as the ways in which the .Stat Suite can be installed.