summaryrefslogtreecommitdiffstats
path: root/SubmittingPatches.rst (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doc: split up SubmittingPatches.rstNathan Cutler2019-10-171-403/+177
| | | | | | | | | | | 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>
* doc: indicate imperative mood for commit titlesPatrick Donnelly2019-08-061-6/+14
| | | | | | This is convention in the kernel and Ceph but is not clearly documented. Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
* SubmittingPatches: added inline markup to important referencesJames McClune2019-01-161-2/+2
| | | | Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
* SubmittingPatches: fix the spelling errorMao Zhongyi2018-05-311-1/+1
| | | | Signed-off-by: Mao Zhongyi <maozy.fnst@cn.fujitsu.com>
* doc/SubmittingPatches.rst: rv double spaces and PleaseNathan Cutler2018-05-231-47/+46
| | | | Signed-off-by: Nathan Cutler <ncutler@suse.com>
* doc/SubmittingPatches.rst: use Google style guide for doc patchesNathan Cutler2018-05-231-5/+7
| | | | Signed-off-by: Nathan Cutler <ncutler@suse.com>
* doc: SubmittingPatches: clarify PR title sectionNathan Cutler2017-08-221-4/+7
| | | | | | | 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>
* doc: add doc requirements on PR submittersJohn Spray2017-07-201-2/+18
| | | | Signed-off-by: John Spray <john.spray@redhat.com>
* doc: clarify SubmittingPatches.rstNathan Cutler2017-01-181-4/+7
| | | | | | | | 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>
* doc: remove ending period in section titlesKefu Chai2016-10-261-8/+8
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* doc: reindent SubmittingPatchesKefu Chai2016-10-201-248/+248
| | | | | | otherwise the content will be rendered as block quotation. Signed-off-by: Kefu Chai <kchai@redhat.com>
* doc: reformat SubmittingPatches with more rst syntaxKefu Chai2016-10-201-14/+43
| | | | | | | | | * 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>
* doc: amend Fixes instructions in SubmittingPatchesNathan Cutler2016-03-251-2/+2
| | | | | | | | | | | | | | | 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>
* SubmittingPatches: rebase to resolve conflictsKefu Chai2016-01-211-0/+13
| | | | | | pull request is not supposed to contain merge commits Signed-off-by: Kefu Chai <kchai@redhat.com>
* SubmittingPatches: sending kernel patches to mailing listKefu Chai2016-01-211-2/+4
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* SubmittingPatches: add doc for commit titleKefu Chai2016-01-211-0/+19
| | | | | | explain that we need a prefix in the commit title Signed-off-by: Kefu Chai <kchai@redhat.com>
* SubmittingPatches: add doc for "Fixes:" tagKefu Chai2016-01-211-1/+10
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* SubmittingPatches: update with reST syntaxKefu Chai2016-01-211-286/+294
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* doc: rename SubmittingPatches to SubmittingPatches.rstKefu Chai2016-01-201-0/+418
for better reading experience Signed-off-by: Kefu Chai <kchai@redhat.com>