Patches are welcome! We currently use the vanilla GitHub merge workflow, where individual pull requests are merged by a human via the web UI.
During the review, any changes should be made as a new commit or an amended commit. These can be force pushed to your branch and GitHub should be able to show the "interdiff" between pushes.
Please look at git log
and match the commit log style, which is very
similar to the
Linux kernel.
You may use Signed-off-by
, but we're not requiring it.
General Commit Message Guidelines:
lib
for library changes, docs
for document changes, bin/<command-name>
for command changes, etc.Closes: #<number>
.Commit Message example:
<context>: Less than 50 characters for subject title
A paragraph of the body should be within 72 characters.
This paragraph is also less than 72 characters.
For more information see How to Write a Git Commit Message
Editing a Committed Message:
To edit the message from the most recent commit run git commit --amend
. To change older commits on the branch use git rebase -i
. For a successful rebase, have the branch track upstream main
. Once the changes have been made and saved, run git push --force origin <branch-name>
.
At a bare minimum, your changes should pass the tests/check.sh
script. This is just
some simple syntax checking, but is better than nothing at all.
A more useful test of your changes would include the following:
coreos-assembler
container imagecoreos-assembler
container image on Quay.io
coreos-assembler build && coreos-assembler run
of Fedora CoreOS using your changes in a "rootless" configuration (i.e. no use of --privileged
)We currently use a mix of bash
shell scripts and Python.
The current preference is to use spaces instead of tabs. We require the use of spaces when working with Python (as covered in PEP8). We will tolerate tabs when working with the shell scripts, but we have a strong preference for spaces. In both cases, we most commonly use 4 spaces per indent. Please follow the convention of the file that you are changing and avoid mixing tabs/spaces whenever possible.
Our enforcement of bash
style is mostly handled via ShellCheck.
We have a loose of set of guidelines being discussed about what we expect for Python style. The agreed upon items:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。