CONTRIBUTING.md

Contributing to bxt

• Contributing to bxt
  • Dev Setup
    • Prerequisits
    • VS Code
  • Submission Guideline
    • Preparing Changes
    • Commit Message Guideline

Dev Setup

Prerequisits

• Docker or Podman (not tested)
• For VS Code the Dev Containers extension

VS Code

• Reopen in Dev container (slow on first run)
• Install recommended extensions into Dev container
• In VS Code terminal: cp /workspaces/bxt/configs/box.yml /workspaces/build/bin/
• Run and debug Daemon (select from bottom controls or left debug panel)
• Open site in your browser at localhost:8080

Submission Guideline

Preparing Changes

We are always happy about fixes for bugs or small design issues. Thanks in advance! If you plan to do larger changes, please create first an issue ticket to let us discuss your plans, so in the end your changes will align with our overall plans for the website and can be merged.

Commit Message Guideline

The Conventional Commits 1.0.0 specification is applied with the following amendments:

• Allowed commit types are these. The "chore" type is allowed, but try to not overuse it.
• Allowed scopes are these
• Any line of the message must be 90 characters or shorter.
• Angular's Revert and Subject policies are applied.