Skip to content

Repository Structure and Contribution Guide #9

Open

Description

@henols

Repository Structure and Contribution Guide

Welcome to the Firestarter project.

This repository (firestarter_prom) is the central project repository and should be the first place contributors look.

Repository overview

firestarter_prom

  • Project roadmap
  • Feature requests
  • Bug reports
  • Release planning
  • Documentation planning
  • Cross-repository coordination
  • GitHub Project planning

This is the only repository where GitHub Issues are maintained.

firestarter_app

  • Python application source code
  • Application implementation
  • Application pull requests

GitHub Issues are disabled.

Please report all bugs and feature requests in:
https://github.com/henols/firestarter_prom/issues

firestarter

  • Firmware source code
  • AVR implementation
  • Hardware communication
  • Firmware pull requests

GitHub Issues are disabled.

Please report all bugs and feature requests in:
https://github.com/henols/firestarter_prom/issues

Where should I report bugs?

Always create issues in:
https://github.com/henols/firestarter_prom/issues

This includes application bugs, firmware bugs, hardware compatibility, documentation, feature requests, and release planning.

Pull Requests

Submit pull requests to the repository containing the code you are changing.

  • Application → firestarter_app
  • Firmware → firestarter
  • Project documentation or planning → firestarter_prom

Cross-repository changes

  1. Create a single issue in firestarter_prom.
  2. Reference that issue from each implementation PR.
  3. Keep design discussion in the issue.
  4. Keep implementation discussion in the relevant PRs.

Repository philosophy

The Firestarter project separates planning from implementation.

  • firestarter_prom is the project hub.
  • firestarter_app contains the application.
  • firestarter contains the firmware.

This structure provides one backlog, one roadmap, one place for users to report issues, independent implementation repositories, and easier release coordination.

Activity

  1. henols commented on Sep 2, 2026

    @henols
    OwnerAuthor

    Following up here with the configured end state this issue's text became the source for.

    Delivered. The repository-structure and contribution guidance this issue originally described has been relocated to the wiki Contributing page: https://github.com/henols/firestarter_prom/wiki/Contributing. The end state it now describes, and that is actually configured across all three repositories:

    • One issue tracker — firestarter_prom — with firestarter and firestarter_app both having Issues disabled.
    • Pull requests go to whichever repository holds the changed code, not to firestarter_prom.
    • main is protected in all three repositories, so contributions arrive by pull request rather than direct push.
    • The orientation text this issue originally carried — what the project is, how the three repositories relate, how to contribute — now lives on that wiki page instead of in this issue's body.

    Nothing was declined against this issue — the guidance it asked for is fully relocated and current.

    Where the surviving tracker is. It is this issue itself. Per the original intent recorded when this repository's issue tracking was centralized, gh#9 stays open as the pinned orientation issue for anyone who lands here first — the natural place to point a first-time visitor before they find the wiki on their own.

  2. pinned this issue on Sep 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions