[libvirt PATCH 1/2] CONTRIBUTING: Add entry point for new contributors

Andrea Bolognani abologna at redhat.com
Mon Apr 6 10:07:05 UTC 2020


It's generally expected that a git repository will contain this file,
which serves as an entry point for people interested in contributing
to the project.

In our case, we have extensive documentation available on the
website which we don't want to duplicate, so let's just point people
there.

Signed-off-by: Andrea Bolognani <abologna at redhat.com>
---
 CONTRIBUTING.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..a8551965bd
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+Contributing to libvirt
+=======================
+
+Full, up to date information on how to contribute to libvirt can be
+found on the libvirt website:
+
+[https://libvirt.org/hacking.html](https://libvirt.org/hacking.html)
+
+To build the same document locally, from the top level directory of
+your git clone run:
+
+```
+$ mkdir build && cd build
+$ ../autogen.sh
+$ make
+```
+
+You'll find the freshly-built document in `docs/hacking.html`.
-- 
2.25.1




More information about the libvir-list mailing list