Skip to content

Commit 869b77c

Browse files
committed
btrfs-progs: README: PR workflow, minor fixes
Mention the basic pull request workflow, the rest are style fixes. [skip ci] Signed-off-by: David Sterba <[email protected]>
1 parent a53aa5d commit 869b77c

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ There are several ways, each has its own specifics and audience that can give
4545
feedback or work on a fix. The following list is sorted in the order of
4646
preference:
4747

48-
* [github issue tracker](https://github.com/kdave/btrfs-progs/issues)
48+
* [Github issue tracker](https://github.com/kdave/btrfs-progs/issues)
4949
* to the mailing list *[email protected]* -- (not required to
5050
subscribe), beware that the mail might get overlooked in other traffic
5151
* IRC (irc.libera.chat #btrfs) -- good for discussions eg. if a bug is already
@@ -57,15 +57,15 @@ Development
5757
-----------
5858

5959
The development takes place in the mailing list (*[email protected]*)
60-
or at github (issues, pull requests). Changes should be split to logical parts
60+
or at Github (issues, pull requests). Changes should be split to logical parts
6161
if possible, documentation may be included in the same patch as to code or
6262
separately.
6363

6464
The development model of btrfs-progs shares a lot with the kernel model. The
6565

66-
* **one logical change per patch**: eg. not mixing bugfixes, cleanups, features
66+
* **one logical change per patch**: e.g. not mixing bugfixes, cleanups, features
6767
etc., sometimes it's not clear and will be usually pointed out during reviews
68-
* proper **subject line**: eg. prefix with _btrfs-progs: subpart, ..._ ,
68+
* proper **subject line**: e.g. prefix with _btrfs-progs: subpart, ..._ ,
6969
descriptive yet not too long, see `git log --oneline` for some inspiration
7070
* proper **changelog**: the changelogs are often missing or lacking explanation _why_
7171
the change was made, or _how_ is something broken, _what_ are user-visible
@@ -80,6 +80,18 @@ The development model of btrfs-progs shares a lot with the kernel model. The
8080
substitute in order to allow contributions without much bothering with
8181
formalities
8282

83+
### Pull requests
84+
85+
The pull requests on Github may be used for code or documentation
86+
contributions. There are basic build checks enabled in the Github actions CI
87+
(first time contributors' pull requests may need an approval). The status can
88+
be checked at the [workflow page](https://github.com/kdave/btrfs-progs/actions/workflows/pull-request.yml).
89+
90+
* open a PR against branches *devel* or *master*
91+
* push update to the same branch if you need to
92+
* close the PR in case it's wrong, a mistake or needs rework
93+
* if you're sure the changes don't need a CI build verification, please add `[skip ci]` to the changelog
94+
8395
Source code coding style and preferences follow the
8496
[kernel coding style](https://www.kernel.org/doc/html/latest/process/coding-style.html).
8597
You can find the editor settings in `.editorconfig` and use the
@@ -98,7 +110,7 @@ Documentation updates
98110
Documentation fixes or updates do not need much explanation so sticking to the
99111
code rules in the previous section is not necessary. GitHub pull requests are
100112
OK, patches could be sent to me directly and not required to be also in the
101-
mailinglist. Pointing out typos via IRC also works, although might get
113+
mailing list. Pointing out typos via IRC also works, although might get
102114
accidentally lost in the noise.
103115

104116
Documentation sources are written in

0 commit comments

Comments
 (0)