Skip to content
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.

Sign up for GitHub

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

Jump to bottom

move(docs/contrib-guidelines): Add contrib guidelines to Maestro #457

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

move(docs/contrib-guidelines): Add contrib guidelines to Maestro #457

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8029d7
move(docs/contrib-guidelines): Add contrib guidelines to Maestro
nuclearcat Sep 12, 2024
4bb126a
add(contacts): Add contacts section
nuclearcat Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions kernelci.org/content/en/maestro/contrib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Contributing Guidelines"
date: 2024-09-12T16:33:00Z
draft: false
weight: 2
---

KernelCI core project is open for contributions. Contributions may consist of
adding new builds, tests and device types as well as features and bugfixes for
KernelCI core tools.
When the PR is created, the [KernelCI staging](https://kernelci.org/docs/instances/staging)
instance takes care of updating the [staging.kernelci.org branch](https://github.com/kernelci/kernelci-core/tree/staging.kernelci.org).
In general the branch is updated every 8h and a limited set of builds and tests
are run on it.

There are several guidelines which can facilitate the PR review process:

1. Make sure the PR is well described
1. Describe the purpose of the changes
2. Example use cases are welcome
2. Attach staging build/test results when possible.
1. If the PR is expected to produce build/test results
check [staging viewer](https://staging.kernelci.org:9000/viewer) and make sure these are mentioned in the PR comment
1. Build artifacts including logs are not kept permanently, so it's generally recommended to put them in a place that'd make them last if you want them to be part of the PR. Good way to do that seem to be:
* Putting important information such as log fragments in the PR comments
* Using services like [pastebin](https://pastebin.com/) to store data important for the PR (e.g. full logs) and pasting the links.
2. If the results are not visible on staging and you think they should be, mention it in the comments, too
3. If there is specific way to verify PR is working as expected, mention it in the comments
3. Make sure that reviewers' comments and questions are addressed
1. When there are comments unanswered for more than 1 month the PR will be closed
4. In case there is a need to consult the PR with KernelCI maintainers join the open hours
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we link to https://docs.kernelci.org/org/#open-hours here?

5. Should you need help, you can reach KernelCI [maintainers](/org/maintainers/) or the community on the [KernelCI website](https://kernelci.org/community-contact/)