diff mbox series

[qemu-web,7/7] Add a CONTRIBUTING.md file as guidance for contributors

Message ID 20201023152957.488974-8-berrange@redhat.com
State New
Headers show
Series Tweaks to page footer and add "edit page" links | expand

Commit Message

Daniel P. Berrangé Oct. 23, 2020, 3:29 p.m. UTC
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++
 _config.yml     |  1 +
 2 files changed, 33 insertions(+)
 create mode 100644 CONTRIBUTING.md

Comments

Paolo Bonzini Oct. 23, 2020, 3:50 p.m. UTC | #1
On 23/10/20 17:29, Daniel P. Berrangé wrote:
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

> ---

>  CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++

>  _config.yml     |  1 +

>  2 files changed, 33 insertions(+)

>  create mode 100644 CONTRIBUTING.md

> 

> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md

> new file mode 100644

> index 0000000..0be58d8

> --- /dev/null

> +++ b/CONTRIBUTING.md

> @@ -0,0 +1,32 @@

> +# Contributing to qemu-web

> +

> +The QEMU project accepts code contributions to the website as patches sent to

> +the the developer mailing list:

> +

> +https://lists.nongnu.org/mailman/listinfo/qemu-devel

> +

> +For further guidance on sending patches consult:

> +

> +https://wiki.qemu.org/Contribute/SubmitAPatch

> +

> +It is expected that contributors check the rendered website before submitting

> +patches. This is possible by either running jekyll locally, or by using the

> +GitLab CI and Pages infrastructure.

> +

> +Any branch that is pushed to a GitLab fork will result in a CI job being run

> +visible at

> +

> +https://gitlab.com/yourusername/libvirt-perl/pipelines


Apart from the pasto, I think it is
https://gitlab.com/yourusername/qemu-web/-/pipelines.

> +The rendered result can be then viewed at

> +

> +https://yourusername.gitlab.io/qemu-web


Very cool, thanks.

Paolo

> +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/

> +

> +To indicate compliance, each commit in a series must have a "Signed-off-by"

> +tag with the submitter's name and email address. This can be added by passing

> +the ``-s`` flag to ``git commit`` when creating the patches.

> diff --git a/_config.yml b/_config.yml

> index d0473c1..7d34779 100644

> --- a/_config.yml

> +++ b/_config.yml

> @@ -40,3 +40,4 @@ exclude:

>    - Gemfile.lock

>    - vendor/

>    - README

> +  - CONTRIBUTING.md

>
diff mbox series

Patch

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..0be58d8
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,32 @@ 
+# Contributing to qemu-web
+
+The QEMU project accepts code contributions to the website as patches sent to
+the the developer mailing list:
+
+https://lists.nongnu.org/mailman/listinfo/qemu-devel
+
+For further guidance on sending patches consult:
+
+https://wiki.qemu.org/Contribute/SubmitAPatch
+
+It is expected that contributors check the rendered website before submitting
+patches. This is possible by either running jekyll locally, or by using the
+GitLab CI and Pages infrastructure.
+
+Any branch that is pushed to a GitLab fork will result in a CI job being run
+visible at
+
+https://gitlab.com/yourusername/libvirt-perl/pipelines
+
+The rendered result can be then viewed at
+
+https://yourusername.gitlab.io/qemu-web
+
+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/
+
+To indicate compliance, each commit in a series must have a "Signed-off-by"
+tag with the submitter's name and email address. This can be added by passing
+the ``-s`` flag to ``git commit`` when creating the patches.
diff --git a/_config.yml b/_config.yml
index d0473c1..7d34779 100644
--- a/_config.yml
+++ b/_config.yml
@@ -40,3 +40,4 @@  exclude:
   - Gemfile.lock
   - vendor/
   - README
+  - CONTRIBUTING.md