]> git.ipfire.org Git - thirdparty/dracut.git/commitdiff
docs: create CONTRIBUTING.md
authorLaszlo Gombos <laszlo.gombos@gmail.com>
Wed, 17 Aug 2022 14:04:49 +0000 (10:04 -0400)
committerJóhann B. Guðmundsson <johannbg@gmail.com>
Thu, 18 Aug 2022 06:03:53 +0000 (06:03 +0000)
Note down some commonly agreed, but not yet documented guidelines
to have a baseline that can be improved later.

CONTRIBUTING.md [new file with mode: 0644]
docs/HACKING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..0d483d3
--- /dev/null
@@ -0,0 +1,22 @@
+We welcome contributions from everyone. However, please follow the following guidelines when posting a GitHub Pull Request or filing a GitHub Issue on the dracut project:
+
+By participating in this project, you agree to abide by the [code of conduct](docs/CODE_OF_CONDUCT.md).
+
+# Filing Issues
+We use GitHub Issues exclusively for tracking bugs and feature requests of dracut.
+
+We only track bugs in the two most recently released versions of dracut in the GitHub Issue tracker.
+If you are using an older version of dracut, please contact your distribution's bug tracker instead (see below). See GitHub Release Page for the list of most recent releases.
+
+When filing an issue, specify the dracut version you are experiencing the issue with. Also, indicate which distribution you are using.
+Please include an explanation how to reproduce the issue you are pointing out.
+
+For more information on Coding Style and Commit messages see [Dracut Developer Guidelines](docs/HACKING.md).
+
+# Older or downstream versions
+For older or downstream versions that are still supported by your distribution please use respective downstream tracker:
+
+[Debian](https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=dracut)
+[Fedora](https://bugzilla.redhat.com/buglist.cgi?quicksearch=dracut)
+[Gentoo](https://bugs.gentoo.org/buglist.cgi?quicksearch=dracut)
+[Opensuse](https://bugzilla.opensuse.org/buglist.cgi?quicksearch=dracut)
index d6279a060bf69c0f201db4752db7327beeedffa6..1cd9db83ae6f90740fdbebcffe5c87237479c403 100644 (file)
@@ -1,11 +1,12 @@
 # Dracut Developer Guidelines
 
+Please make sure to follow our [Contribution Guidelines](CONTRIBUTING.md).
+
 ## git
 
-Currently dracut lives on github.com and kernel.org.
+Currently dracut lives on github.com.
 
 * https://github.com/dracutdevs/dracut.git
-* https://git.kernel.org/pub/scm/boot/dracut/dracut.git
 
 Pull requests should be filed preferably on github nowadays.