Skip to content

Commit ae2a294

Browse files
berrangebonzini
authored andcommitted
Add a CONTRIBUTING.md file as guidance for contributors
Signed-off-by: Daniel P. Berrangé <[email protected]> Message-Id: <[email protected]> Signed-off-by: Paolo Bonzini <[email protected]>
1 parent 9db5d6b commit ae2a294

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing to qemu-web
2+
3+
The QEMU project accepts code contributions to the website as patches sent to
4+
the the developer mailing list:
5+
6+
https://lists.nongnu.org/mailman/listinfo/qemu-devel
7+
8+
For further guidance on sending patches consult:
9+
10+
https://wiki.qemu.org/Contribute/SubmitAPatch
11+
12+
It is expected that contributors check the rendered website before submitting
13+
patches. This is possible by either running jekyll locally, or by using the
14+
GitLab CI and Pages infrastructure.
15+
16+
Any branch that is pushed to a GitLab fork will result in a CI job being run
17+
visible at
18+
19+
https://gitlab.com/yourusername/qemu-web/-/pipelines
20+
21+
The rendered result can be then viewed at
22+
23+
https://yourusername.gitlab.io/qemu-web
24+
25+
Contributions submitted to the project must be in compliance with the
26+
Developer Certificate of Origin Version 1.1. This is documented at:
27+
28+
https://developercertificate.org/
29+
30+
To indicate compliance, each commit in a series must have a "Signed-off-by"
31+
tag with the submitter's name and email address. This can be added by passing
32+
the ``-s`` flag to ``git commit`` when creating the patches.

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,4 @@ exclude:
4040
- Gemfile.lock
4141
- vendor/
4242
- README
43+
- CONTRIBUTING.md

0 commit comments

Comments
 (0)