From c8a8ef48e5ead9df44b765407e93d0c98a154e17 Mon Sep 17 00:00:00 2001 From: Sebastian Lackner Date: Sat, 22 Jul 2017 04:07:01 +0200 Subject: [PATCH] Add a separate CONTRIBUTING.md. --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ README.md | 23 ++--------------------- 2 files changed, 32 insertions(+), 21 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d8fc6e57 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +Contributing to Wine Staging +---------------------------- + +First of all, thank you for taking the time to contribute to this project. + +### Reporting bugs + +Since WineConf 2015 Wine Staging is an official part of WineHQ, which means you +can report problems directly at [bugs.winehq.org](https://bugs.winehq.org/). +Most of the time bugs found in Wine Staging also turn out to be present in the +development branch, so its recommended to open your bug in the "Wine" product, +unless you are sure its really "Wine Staging" specific. For bugs related to our +binary packages, please open a bug report in the "Packaging" product. + +### Submitting patches + +** IMPORTANT: Please use [dev.wine-staging.com](https://dev.wine-staging.com/patches) +for patch submission, we currently do not accept Pull requests on GitHub. ** + +Wine Staging mainly concentrates on experimental features and patches which are +difficult to get into the development branch. If you have a very simple bug fix +including tests, there is usually no need to send it to Wine Staging. You can +directly contribute it to the +[development branch](http://wiki.winehq.org/SubmittingPatches). However, if you +already tried that without success, or are working on such a complex area that +you do not really think its ready for inclusion, you might want to submit it to +our Staging tree. Please open a patch submission request on +[dev.wine-staging.com](https://dev.wine-staging.com/patches) including the patch. +More information is also available in our +[Wiki](https://wiki.winehq.org/Wine-Staging_Patches). diff --git a/README.md b/README.md index b412b167..2b2fa1d2 100644 --- a/README.md +++ b/README.md @@ -24,16 +24,6 @@ other wine-specific programs like `winecfg`. To learn more about how to use Wine Staging, please take a look at the [usage instructions](https://github.com/wine-compholio/wine-staging/wiki/Usage). -Reporting bugs --------------- - -Since WineConf 2015 Wine Staging is an official part of WineHQ, which means you -can report problems directly at https://bugs.winehq.org/. Most of the time bugs -found in Wine Staging also turn out to be present in the development branch, so -its recommended to open your bug in the "Wine" product, unless you are sure its -really "Wine Staging" specific. For problems with our binary packages, please -also open a bug report there. - Building -------- @@ -88,14 +78,5 @@ in our [Wiki](https://github.com/wine-compholio/wine-staging/wiki/Packaging). Contributing ------------ -Wine Staging mainly concentrates on experimental features and patches which are -difficult to get into the development branch. If you have a very simple bug fix -including tests, there is usually no need to send it to Wine Staging. You can -directly contribute it to the -[development branch](http://wiki.winehq.org/SubmittingPatches). However, if you -already tried that without success, or are working on such a complex area that -you do not really think its ready for inclusion, you might want to submit it to -our Staging tree. Please open a patch submission request on -[bugs.wine-staging.com](https://bugs.wine-staging.com/) including the patch. -More information is also available in our -[Wiki](https://github.com/wine-compholio/wine-staging/wiki/Contributing). +Please see CONTRIBUTING.md for more information about contributing to Wine +Staging.