Skip to content

Commit

Permalink
doc: add downstream CONTRIBUTING document
Browse files Browse the repository at this point in the history
rhel-only: doc

Related: RHEL-40924
  • Loading branch information
jamacku committed Jun 27, 2024
1 parent ee9a767 commit 60450fb
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 1 deletion.
75 changes: 75 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Contributing

Welcome to systemd source-git for CentOS Stream and RHEL. When contributing, please follow the guide below.

## Workflow

```mermaid
flowchart LR
A(Issue) --> B{is fixed\nupstream}
B -->|YES| C(backport\nupstream patch)
B -->|NO| D(upstream\nsubmit issue or PR)
D --> E{accepted\nand fixed}
E -->|YES| C
E -->|NO| F(rhel-only patch) --> G
C --> G(submit PR)
```

## Filing issues

When you find an issue with systemd used in **CentOS Stream** or **RHEL**, please file an issue in Red Hat [Jira ticket system](https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332745&issuetype=1&components=12380515).

GitHub Issues are not supported tracking system. If your issue is reproducible using the latest upstream version of systemd, please consider creating [upstream issue](https://github.com/systemd/systemd/issues/new/choose).

## Posting Pull Requests

Every Pull Request has to comply with the following rules:

- Each commit has to reference [upstream](https://github.com/systemd/systemd) commit.
- Each commit has to reference the approved issue/tracker.
- Pull requests have to pass mandatory CI validation and testing
- Pull requests have to be approved by at least one systemd downstream maintainer

### Upstream reference

When doing a back-port of an upstream commit, always use `cherry-pick -x <sha>`. Consider proposing a change upstream first when an upstream commit doesn't exist.
If the change isn't upstream relevant or accepted by upstream, mark the commit with the `rhel-only: <parameter>` string, where a `<parameter>` is:

- `feature` - for feature-related commits (cross-version)
- `bugfix` - for bugfix-related commits (cross-version)
- `doc` - for documentation-related commits (usually version-specific)
- `workaround` - for workaround-related commits (usually version-specific)
- `ci` - for CI-related commits (version-specific)
- `test` - for test-related commits (version-specific)
- `other` - for commits that do not fit into any of the above categories (version-specific)

```md
doc: Fix TYPO

rhel-only: doc

Resolves: RHEL-678
```

### Issue reference

Each commit has to reference the relevant approved systemd issue (see: [Filling issues section](#filing-issues)). For referencing issues, we use the following keywords:

- **Resolves** for commits that directly resolve issues described in a referenced tracker
- **Related** for commits related to the referenced issue, but they don't fix it. Usually, tests and documentation.
- **Reverts** for commits that reverts previously merged commit

When referencing issues, use the following structure: `<keyword>: <issue ID>`. See the example below:

```md
doc: Fix TYPO

(cherry picked from commit c5afbac31bb33e7b1f4d59b253425af991a630a4)

Resolves: RHEL-678
```

### Validation and testing

Each Pull Request has to pass all enabled tests that are automatically run using GitHub Actions, CentOS Stream CI, and others.
If CI failure is unrelated to the change introduced in Pull Request, the downstream maintainer will set the `ci-waived` label and explain why CI was waived.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Please see the [Code Map](docs/ARCHITECTURE.md) for information about this repos

Please see the [Hacking guide](docs/HACKING.md) for information on how to hack on systemd and test your modifications.

Please see our [Contribution Guidelines](docs/CONTRIBUTING.md) for more information about filing GitHub Issues and posting GitHub Pull Requests.
Please see our [Contribution Guidelines](CONTRIBUTING.md) for more information about filing GitHub Issues and posting GitHub Pull Requests.

When preparing patches for systemd, please follow our [Coding Style Guidelines](docs/CODING_STYLE.md).

Expand Down

0 comments on commit 60450fb

Please sign in to comment.