summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorCole Robinson <crobinso@redhat.com>2020-09-20 14:26:40 -0400
committerCole Robinson <crobinso@redhat.com>2020-09-20 14:35:05 -0400
commit81eae9b181eda66b0a6d534076bc3ad56421bea3 (patch)
treeca2ef1176cdd99da0ff950b54983dea8a5b250a4 /CONTRIBUTING.md
parent092a62552cbca7fcaf52ec0e3bebedc8c3288894 (diff)
downloadvirt-manager-81eae9b181eda66b0a6d534076bc3ad56421bea3.tar.gz
docs: Add github ISSUE_TEMPLATE
Adjust existing docs to better document running code from git Signed-off-by: Cole Robinson <crobinso@redhat.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md32
1 files changed, 23 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2d7a5d10..3fab344e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,18 +1,32 @@
# Contribute to virt-manager
+## Run code from git
+
+Generally virt-* tools can be run straight from git. For example
+for virt-manager:
+
+```
+git clone https://github.com/virt-manager/virt-manager
+cd virt-manager
+./virt-manager --debug
+```
+
+The other tools like `virt-install` should work similarly. This
+expects you already have a distro provided version of virt-manager
+installed which pulled in all the necessary dependencies. If not,
+see [INSTALL.md](INSTALL.md) for more hints about finding the
+correct dependencies.
+
## Bug reporting
-We use our [github issue tracker](https://github.com/virt-manager/virt-manager/issues)
-for bug reporting. Previously we used bugzilla.redhat.com but nowadays
-github is preferred.
+Bug reports should go to our [github issue tracker](https://github.com/virt-manager/virt-manager/issues).
-Please only file issues if they apply to the latest version of
-virt-manager. If you are using an older version from a distro,
-please file a bug in your distro's bug tracker..
+The bug tracker is for issues affecting the latest code only.
+If you are using a distro provided package like from Ubuntu or
+Fedora, please file a bug in their bug tracker.
-When filing a bug, please reproduce the issue with the `--debug`
-flag passed to the tool and attach the full output in the bug
-report.
+If you suspect the bug also affects upstream code, please confirm
+it by running the latest code using the steps above.
## Writing patches