Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.35 KB

Contributing to blizzard

This document is mainly intended for people who want to contribute to blizzard. As a short reminder, this is generally what you would need to do:

  1. Fork and clone the repository
  2. Either stay on the main branch, or create a new branch for your feature [feat|fix|...]/<name>. If you are working on multiple PRs at the same time, you should create new branches.
  3. Run nix develop.
  4. Read the chapter below and implement your changes
  5. Once finished, create a commit, push your changes and submit a PR.

Requirements for submitted changes

If you want to submit a change, please make sure you have checked the following things:

  • All checks must pass. You can run them with nix flake check, which will also check formatting.

  • This repository follows the Conventional Commits style. So each commit in your PR should contain only one logical change and the commit message should reflect that accordingly.

    Example: If your PR changes changes the installer stage and kexec, you should also have two commits:

    • feat(kexec): add additional tools to the final kexec image
    • feat(stages/preinstall): speed up the checks

    Changes should be scoped like feat(kexec), same for stages/<stage_name>. If a change doesn't fit any of these scopes, then just don't add a scope.