From 8a52fe144937d6e81a2520591f63c6b51ee452b6 Mon Sep 17 00:00:00 2001 From: Jan Bronicki Date: Mon, 30 Mar 2026 15:36:35 +0200 Subject: [PATCH] docs: refactor contributing guidelines Signed-off-by: Jan Bronicki --- CONTRIBUTING.md | 72 ++----------------- changelog/bugfixes/2026-03-25-ignition-oem.md | 1 - .../.repo/manifests/mantle-container | 2 +- .../files/0018-usr-share-oem-oem.patch | 48 +++++-------- ...tory-before-attempting-to-mount-OEM-.patch | 44 ------------ ...ed-ioutil.TempDir-call-with-os.Mkdir.patch | 34 --------- ....24.0-r1.ebuild => ignition-2.24.0.ebuild} | 0 .../sys-apps/ignition/ignition-9999.ebuild | 2 - 8 files changed, 25 insertions(+), 178 deletions(-) delete mode 100644 changelog/bugfixes/2026-03-25-ignition-oem.md delete mode 100644 sdk_container/src/third_party/coreos-overlay/sys-apps/ignition/files/0020-Create-mnt-directory-before-attempting-to-mount-OEM-.patch delete mode 100644 sdk_container/src/third_party/coreos-overlay/sys-apps/ignition/files/0021-Replace-deprecated-ioutil.TempDir-call-with-os.Mkdir.patch rename sdk_container/src/third_party/coreos-overlay/sys-apps/ignition/{ignition-2.24.0-r1.ebuild => ignition-2.24.0.ebuild} (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6662073a848..ac4bba3bbfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,71 +1,13 @@ -# How to Contribute +Welcome! We're so glad you're here and interested in contributing to Flatcar! 💖 -CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via -GitHub pull requests. This document outlines some of the conventions on -development workflow, commit message formatting, contact points and other -resources to make it easier to get your contribution accepted. +Whether you're fixing a bug, adding a feature, or improving docs — we appreciate you! -# Certificate of Origin +For more detailed guidelines (finding issues, community meetings, PR lifecycle, commit message format, and more), check out the [main Flatcar CONTRIBUTING guide](https://github.com/flatcar/Flatcar/blob/main/CONTRIBUTING.md). -By contributing to this project you agree to the Developer Certificate of -Origin (DCO). This document was created by the Linux Kernel community and is a -simple statement that you, as a contributor, have the legal right to make the -contribution. See the [DCO](DCO) file for details. +--- -# Email and Chat +## Repository Specific Guidelines -The project currently uses the general CoreOS email list and IRC channel: -- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev) -- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org +Any guidelines specific to this repository that are not covered in the main contribution guide will be listed here. -Please avoid emailing maintainers found in the MAINTAINERS file directly. They -are very busy and read the mailing lists. - -## Getting Started - -- Fork the repository on GitHub -- Read the [README](README.md) for build and test instructions -- Play with the project, submit bugs, submit patches! - -## Contribution Flow - -This is a rough outline of what a contributor's workflow looks like: - -- Create a topic branch from where you want to base your work (usually master). -- Make commits of logical units. -- Make sure your commit messages are in the proper format (see below). -- Push your changes to a topic branch in your fork of the repository. -- Make sure the tests pass, and add any new tests as appropriate. -- Submit a pull request to the original repository. - -Thanks for your contributions! - -### Format of the Commit Message - -We follow a rough convention for commit messages that is designed to answer two -questions: what changed and why. The subject line should feature the what and -the body of the commit should describe the why. - -``` -scripts: add the test-cluster command - -this uses tmux to setup a test cluster that you can easily kill and -start for debugging. - -Fixes #38 -``` - -The format can be described more formally as follows: - -``` -: - - - -