Skip to main content

Intro

This document describes the development process and tools for MijnBureau. It aims to provide an easy and efficient way to contribute to the project.

Getting Started​

If you have an idea or want to make changes, you will need to create a Pull Request (PR) on the MijnBureau GitHub repository. For significant changes or new components, it is recommended to first create an Issue on the repository. This allows you to discuss the change and avoid spending time on something that might be declined due to architectural or business reasons.

Steps to Contribute​

  1. Fork the Repository:

  2. Create a Branch:

    • Create a new branch for your changes.

  3. Submit a Pull Request:

Tools​

To simplify development for new contributors, we provide DevContainers. These containers include all the required tools for developing MijnBureau applications.

Using DevContainers​

To start a DevContainer in VS Code, refer to this manual.

Installing Tools Locally​

If you prefer not to use DevContainers, you can install the required tools on your machine. The most important tools are:

Additional Tools​

For testing and policy adherence, you may need the following tools:

  • Python3: Required for GitLint.
  • Node.js & npm: Used for Prettier formatting.
  • Conftest: For policy testing with the Rego language.
  • Regal: For policy editing.
  • Kubeconform: For Kubernetes manifest validation.

Helmfile​

Helmfile requires plugins to function. Install the necessary plugins by running:

helmfile init