Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

37 lines (29 loc) · 2.14 KB
Raw

Contributing to nix-topology

This document is mainly intended for people who want to contribute to nix-topology. 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. You will be put into a shell with a pre-commit-hook that automatically checks and lints your changes before you push.
  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.

  • The documentation must build successfully, you can run it with nix build .#docs. The examples also serve as our tests and are automatically included in the docs.

  • 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 adds two service extractors, you should also have two commits:

    • feat(extractors/services): Add support for vaultwarden
    • feat(extractors/services): Add support for forgejo

    Changes to extractors should be scoped like feat(extractors/<extractor_name>), same for renderers/<renderer_name> and options/<option_name>. If a change doesn't fit any of these scopes, then just don't add a scope.

  • I'm generally happy to accept any extractor, but please make sure they meet the extractor criteria from the documentation

Please also read through the Development section in the documentation, as it contains some general information about the project and also some hints, for example on how to add an extractor.