[libvirt-python PATCH] gitlab: add CONTRIBUTING.rst file to indicate use of merge requests
With the introduce of automated CI pipelines, we are now ready to switch to using merge requests for the project. With this switch we longer wish to have patches sent to the mailing list, and thus the git-publish config is removed. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- .gitpublish | 4 ---- CONTRIBUTING.rst | 28 ++++++++++++++++++++++++++++ This CONTRIBUTING.rst is intentionally fairly generic, as I intend to reuse it for most other projects too (libvirt.git being the exception which has far more details). 2 files changed, 28 insertions(+), 4 deletions(-) delete mode 100644 .gitpublish create mode 100644 CONTRIBUTING.rst diff --git a/.gitpublish b/.gitpublish deleted file mode 100644 index dced716..0000000 --- a/.gitpublish +++ /dev/null @@ -1,4 +0,0 @@ -[gitpublishprofile "default"] -base = master -to = libvir-list@redhat.com -prefix = libvirt-python PATCH diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..11e3c41 --- /dev/null +++ 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 + +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' +own private repository fork: + + https://gitlab.com/::YOUR-USER-NAME::/libvirt-python/pipelines + +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" +tag with the submittor's name and email address. This can be added by passing +the ``-s`` flag to ``git commit`` when creating the patches. -- 2.26.2
On Fri, May 01, 2020 at 02:13:26PM +0100, Daniel P. Berrangé wrote:
With the introduce of automated CI pipelines, we are now ready to switch
s/introduce/introduction/
to using merge requests for the project. With this switch we longer wish to have patches sent to the mailing list, and thus the git-publish config is removed.
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- .gitpublish | 4 ---- CONTRIBUTING.rst | 28 ++++++++++++++++++++++++++++
This CONTRIBUTING.rst is intentionally fairly generic, as I intend to reuse it for most other projects too (libvirt.git being the exception which has far more details).
2 files changed, 28 insertions(+), 4 deletions(-) delete mode 100644 .gitpublish create mode 100644 CONTRIBUTING.rst
diff --git a/.gitpublish b/.gitpublish deleted file mode 100644 index dced716..0000000 --- a/.gitpublish +++ /dev/null @@ -1,4 +0,0 @@ -[gitpublishprofile "default"] -base = master -to = libvir-list@redhat.com -prefix = libvirt-python PATCH diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..11e3c41 --- /dev/null +++ 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 + +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' +own private repository fork: + + https://gitlab.com/::YOUR-USER-NAME::/libvirt-python/pipelines + +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" +tag with the submittor's name and email address. This can be added by passing +the ``-s`` flag to ``git commit`` when creating the patches. -- 2.26.2
Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
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
participants (2)
-
Andrea Bolognani -
Daniel P. Berrangé