Skip to content

Document the core Zarf principles #3552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brandtkeller opened this issue Mar 3, 2025 · 0 comments · May be fixed by #3562
Open

Document the core Zarf principles #3552

brandtkeller opened this issue Mar 3, 2025 · 0 comments · May be fixed by #3562
Assignees
Labels
documentation 📘 Improvements or additions to documentation

Comments

@brandtkeller
Copy link
Member

Purpose

The guidelines and principles for which Zarf is both developed as well as future changes should stem from a set of design principles such that new requests or development can be measured for adherence with the design principles.

This also mitigates new feature suggestions that may have unforeseen implications from being seen as subjectively reviewed (for what does or does not get implemented) and instead may provide more objectives measures for reference and review.

Following inspirations from sources such as:

Potential Targets

  • Airgap native: Ensuring all functionality in zarf supports an airgapped ecosystem by default. Configurations can be exposed which rely on external/host dependencies - but no new functionality should ever prohibit zarf from being able to perform the lifecycle of actions without said dependency.
  • Tooling Inclusion: Selection of tools which get vendored into Zarf and the justification
@brandtkeller brandtkeller added the documentation 📘 Improvements or additions to documentation label Mar 3, 2025
@brandtkeller brandtkeller added this to Zarf Mar 3, 2025
@github-project-automation github-project-automation bot moved this to Triage in Zarf Mar 3, 2025
@brandtkeller brandtkeller moved this from Triage to Backlog in Zarf Mar 10, 2025
@brandtkeller brandtkeller self-assigned this Mar 10, 2025
@brandtkeller brandtkeller moved this from Backlog to In progress in Zarf Mar 10, 2025
@brandtkeller brandtkeller linked a pull request Mar 10, 2025 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Improvements or additions to documentation
Projects
Status: In progress
Development

Successfully merging a pull request may close this issue.

1 participant