Skip to content

Commit

Permalink
README: Add osbuild-composer's principles
Browse files Browse the repository at this point in the history
  • Loading branch information
ochosi authored and ondrejbudai committed Apr 10, 2024
1 parent 484c82c commit 006c7a6
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,28 @@ instance, includes a
[Cockpit Module](https://github.com/osbuild/cockpit-composer) or using the
[composer-cli](https://weldr.io/lorax/composer-cli.html) command-line tool.

### Project
## Project

* **Website**: <https://www.osbuild.org>
* **Bug Tracker**: <https://github.com/osbuild/osbuild-composer/issues>
* **matrix**: https://matrix.to/#/#image-builder:fedoraproject.org
* **Mailing List**: [email protected]
* **Matrix**: https://matrix.to/#/#image-builder:fedoraproject.org
* **Mailing List**: [email protected]
* **Changelog**: <https://github.com/osbuild/osbuild-composer/releases>

#### Contributing
### Principles

Please refer to the [developer guide](https://www.osbuild.org/docs/developer-guide/index/) to learn about our workflow, code style and more.
1. OSBuild Composer shall only allow users to do what generally makes sense.
2. Blueprints are the policy layer where we decide what to expose to end users.
3. If a blueprint can be built, it should also boot.
4. It should be obvious why a blueprint doesn’t build.
5. The [cloud API](./internal/cloudapi) is never broken.
6. In the hosted service, OSBuild Composer is an orchestrator of image builds.
7. On-premises, it should be as easy as possible to run the service and build an image.
8. OSBuild Composer needs to run on the oldest supported target distribution.

### Contributing

Please refer to the [developer guide](https://osbuild.org/docs/developer-guide/index) to learn about our workflow, code style and more.

### About

Expand Down

0 comments on commit 006c7a6

Please sign in to comment.