@@ -45,7 +45,7 @@ There are several ways, each has its own specifics and audience that can give
45
45
feedback or work on a fix. The following list is sorted in the order of
46
46
preference:
47
47
48
- * [ github issue tracker] ( https://github.com/kdave/btrfs-progs/issues )
48
+ * [ Github issue tracker] ( https://github.com/kdave/btrfs-progs/issues )
49
49
* to the mailing list
* [email protected] * -- (not required to
50
50
subscribe), beware that the mail might get overlooked in other traffic
51
51
* IRC (irc.libera.chat #btrfs) -- good for discussions eg. if a bug is already
@@ -57,15 +57,15 @@ Development
57
57
-----------
58
58
59
59
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
61
61
if possible, documentation may be included in the same patch as to code or
62
62
separately.
63
63
64
64
The development model of btrfs-progs shares a lot with the kernel model. The
65
65
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
67
67
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, ..._ ,
69
69
descriptive yet not too long, see ` git log --oneline ` for some inspiration
70
70
* proper ** changelog** : the changelogs are often missing or lacking explanation _ why_
71
71
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
80
80
substitute in order to allow contributions without much bothering with
81
81
formalities
82
82
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
+
83
95
Source code coding style and preferences follow the
84
96
[ kernel coding style] ( https://www.kernel.org/doc/html/latest/process/coding-style.html ) .
85
97
You can find the editor settings in ` .editorconfig ` and use the
@@ -98,7 +110,7 @@ Documentation updates
98
110
Documentation fixes or updates do not need much explanation so sticking to the
99
111
code rules in the previous section is not necessary. GitHub pull requests are
100
112
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
102
114
accidentally lost in the noise.
103
115
104
116
Documentation sources are written in
0 commit comments