From: Laszlo Gombos Date: Wed, 17 Aug 2022 14:04:49 +0000 (-0400) Subject: docs: create CONTRIBUTING.md X-Git-Tag: 058~180 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=025906de2392c3293d3006344b0ffe9148b31932;p=thirdparty%2Fdracut.git docs: create CONTRIBUTING.md Note down some commonly agreed, but not yet documented guidelines to have a baseline that can be improved later. --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..0d483d318 --- /dev/null +++ b/CONTRIBUTING.md @@ -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) diff --git a/docs/HACKING.md b/docs/HACKING.md index d6279a060..1cd9db83a 100644 --- a/docs/HACKING.md +++ b/docs/HACKING.md @@ -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.