Varsha Rao
5b34a9bbf5
doc/SubmittingPatches: Fix 'Fixes line' hyperlink
...
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-04-13 19:29:35 +05:30
Nathan Cutler
ec6af09384
doc: split up SubmittingPatches.rst
...
Split the existing SubmittingPatches.rst into three files:
* SubmittingPatches.rst (general guidelines, for GitHub/master branch)
* SubmittingPatches-kernel.rst (for kernel patches)
* SubmittingPatches-backports.rst (for backports)
Fixes: http://tracker.ceph.com/issues/20953
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2019-10-17 19:32:03 +02:00
Patrick Donnelly
e72f590477
doc: indicate imperative mood for commit titles
...
This is convention in the kernel and Ceph but is not clearly documented.
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-08-06 11:18:21 -07:00
James McClune
d78863e049
SubmittingPatches: added inline markup to important references
...
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2019-01-15 22:42:05 -05:00
Mao Zhongyi
831cbfb285
SubmittingPatches: fix the spelling error
...
Signed-off-by: Mao Zhongyi <maozy.fnst@cn.fujitsu.com>
2018-05-31 20:35:39 +08:00
Nathan Cutler
47ff2bf0d5
doc/SubmittingPatches.rst: rv double spaces and Please
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-05-23 20:29:37 +02:00
Nathan Cutler
6f2e7cada8
doc/SubmittingPatches.rst: use Google style guide for doc patches
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-05-23 20:24:23 +02:00
Nathan Cutler
c8cefc3a5b
doc: SubmittingPatches: clarify PR title section
...
There is no real limit on the length of PR titles, other than whatever limit is
imposed by the GitHub GUI/API.
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-08-22 11:06:04 +02:00
John Spray
b0b931858d
doc: add doc requirements on PR submitters
...
Signed-off-by: John Spray <john.spray@redhat.com>
2017-07-19 20:00:10 -04:00
Nathan Cutler
736b8039f5
doc: clarify SubmittingPatches.rst
...
This commit clarifies that folks opening bugfix PRs that need backporting to
one or more stable branches should always target master, and that the
backporting itself takes place only after the master PR is merged.
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-01-18 22:20:17 +01:00
Kefu Chai
68ba90d629
doc: remove ending period in section titles
...
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-10-26 17:53:22 +08:00
Kefu Chai
3898dc0123
doc: reindent SubmittingPatches
...
otherwise the content will be rendered as block quotation.
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-10-20 12:13:52 +08:00
Kefu Chai
f40296165f
doc: reformat SubmittingPatches with more rst syntax
...
* group some paragraphs into sections, so we can link to them via its
html anchor.
* remove unrelated contents.
* add cross-refs.
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-10-20 11:54:10 +08:00
Nathan Cutler
65770059cb
doc: amend Fixes instructions in SubmittingPatches
...
Since the "Fixes: #..." line is interpreted by GitHub as referring to a
pull request, yet the intention is for it to refer to the tracker issue,
change our instructions to use the full tracker issue URL.
Now that github pull request numbers are in the 8000s, there are cases when
a PR is wrongly closed by a "Fixes: #..." line in a commit message. See
https://github.com/ceph/ceph/pull/8286#event-603120191
for one such case.
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-25 17:39:39 +01:00
Kefu Chai
4d00a1418e
SubmittingPatches: rebase to resolve conflicts
...
pull request is not supposed to contain merge commits
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-01-21 13:12:48 +08:00
Kefu Chai
a2c1b53684
SubmittingPatches: sending kernel patches to mailing list
...
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-01-21 13:12:48 +08:00
Kefu Chai
18409a897b
SubmittingPatches: add doc for commit title
...
explain that we need a prefix in the commit title
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-01-21 13:12:48 +08:00
Kefu Chai
dbabbd03b7
SubmittingPatches: add doc for "Fixes:" tag
...
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-01-21 12:27:54 +08:00
Kefu Chai
2b5588a1a8
SubmittingPatches: update with reST syntax
...
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-01-21 12:27:54 +08:00
Kefu Chai
a9cd257513
doc: rename SubmittingPatches to SubmittingPatches.rst
...
for better reading experience
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-01-20 13:28:38 +08:00
