On Fri, 2020-05-01 at 14:13 +0100, Daniel P. Berrangé wrote:
+++ b/CONTRIBUTING.rst @@ -0,0 +1,28 @@ +============================== +Contributing to libvirt-python +============================== + +The libvirt Python API binding accepts code contributions via merge requests +on the GitLab project: + + https://gitlab.com/libvirt/libvirt-python/-/merge_requests
Indenting the link will result in reStructuredText interpreting it as a block quote, which I don't think is what we want. libvirt's own README.rst file doesn't indent link, which doesn't look too good in text format but is okay once rendered to HTML.
+It is required that automated CI pipelines succeed before a merge request +will be accepted. The global pipeline status for the ``master`` branch is +visible at: + + https://gitlab.com/libvirt/libvirt-python/pipelines + +CI pipline results for merge requests will be visible via the contributors'
s/pipline/pipeline/
+own private repository fork: + + https://gitlab.com/::YOUR-USER-NAME::/libvirt-python/pipelines
I think the shouting is unnecessary, how about https://gitlab.com/yourusername/libvirt-python/pipeline instead?
+Contributions submitted to the project must be in compliance with the +Developer Certificate of Origin Version 1.1. This is documented at: + + https://developercertificate.org/ + +In indicate compliance, each commit in a series must have a "Signed-off-by"
s/In/To/
+tag with the submittor's name and email address. This can be added by passing
s/submittor/submitter/ -- Andrea Bolognani / Red Hat / Virtualization