Skip to content

Commit 5348778

Browse files
committed
Minor top level docs reformatting
Signed-off-by: David Cantrell <[email protected]>
1 parent 614ec05 commit 5348778

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

CONTRIBUTING.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,14 @@ Using
88
git commit -s
99
```
1010

11-
to sign-off on commits is preferred, but not required. See https://developercertificate.org/ for more information.
11+
to sign-off on commits is preferred, but not required. See
12+
https://developercertificate.org/ for more information.
1213

1314
### Short Log Headers
1415

15-
To categorize commits and make release log generation easier, please use categorization headers on the first line of git commit messages. The headers the project uses are:
16+
To categorize commits and make release log generation easier, please
17+
use categorization headers on the first line of git commit messages.
18+
The headers the project uses are:
1619

1720
| Prefix | Description |
1821
| ------ | ----------- |
@@ -28,11 +31,16 @@ To categorize commits and make release log generation easier, please use categor
2831

2932
This list may expand over time.
3033

31-
NOTE: Short log messages without a header like this will be excluded from release announcements. That may be appropriate for some commits.
34+
NOTE: Short log messages without a header like this will be excluded
35+
from release announcements. That may be appropriate for some commits.
3236

3337
### Consolidated Project History
3438

35-
Sending pull requests is the preferred workflow, which means contributors need to track the upstream repo in their forked copies. Please avoid merge commits as you update your forks so that the commit history in the main project is consolidated. An easy way to do that is:
39+
Sending pull requests is the preferred workflow, which means
40+
contributors need to track the upstream repo in their forked copies.
41+
Please avoid merge commits as you update your forks so that the commit
42+
history in the main project is consolidated. An easy way to do that
43+
is:
3644

3745
```sh
3846
git checkout master
@@ -42,4 +50,8 @@ git rebase upstream/master
4250
git push -f
4351
```
4452

45-
This will track upstream and rebase your copy to the upstream copy. The force push is required to your copy since you are rewriting the project history to match upstream. You need to do this on a clean repo, so stash anything you are working on and ensure your copy is clean.
53+
This will track upstream and rebase your copy to the upstream copy.
54+
The force push is required to your copy since you are rewriting the
55+
project history to match upstream. You need to do this on a clean
56+
repo, so stash anything you are working on and ensure your copy is
57+
clean.

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ following environments:
2929

3030
[x86_64](https://en.wikipedia.org/wiki/X86-64):
3131

32-
| Platform | Release | Status |
32+
| Platform | Release | Status |
3333
|:-------------------------------------------------------|:----|----:|
3434
| [Fedora Linux](https://getfedora.org/) | rawhide<br />stable | [![Fedora Linux](https://github.com/rpminspect/rpminspect/actions/workflows/fedora.yml/badge.svg)](https://github.com/rpminspect/rpminspect/actions/workflows/fedora.yml) |
3535
| [CentOS](https://www.centos.org/) | Stream 9<br />Stream 8<br />7 | [![CentOS](https://github.com/rpminspect/rpminspect/actions/workflows/centos.yml/badge.svg)](https://github.com/rpminspect/rpminspect/actions/workflows/centos.yml) |
@@ -48,7 +48,7 @@ following environments:
4848

4949
In addition to the above test runs, rpminspect is built for Fedora Linux on these platforms:
5050

51-
| Platform | Status |
51+
| Platform | Status |
5252
|:-------------------|----:|
5353
| [aarch64](https://en.wikipedia.org/wiki/AArch64) | [![Fedora Linux aarch64](https://github.com/rpminspect/rpminspect/actions/workflows/fedora-aarch64.yml/badge.svg)](https://github.com/rpminspect/rpminspect/actions/workflows/fedora-aarch64.yml) |
5454
| [ppc64le](https://en.wikipedia.org/wiki/Ppc64) | [![Fedora Linux ppc64le](https://github.com/rpminspect/rpminspect/actions/workflows/fedora-ppc64le.yml/badge.svg)](https://github.com/rpminspect/rpminspect/actions/workflows/fedora-ppc64le.yml) |

0 commit comments

Comments
 (0)