From 600268ba65539771dac67d316e2d2a0d999e7b42 Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Wed, 8 Apr 2020 21:47:14 -0400 Subject: [PATCH] Tweak and update github templates. --- .github/CONTRIBUTING.md | 13 +++++++------ .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 95ebd86a..7f6f8af3 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,12 +1,13 @@ VCV Rack is [open-source](https://opensource.org/osd) but not [open-contribution](https://opensource.guide/how-to-contribute/). -I am unable to accept free code contributions to Rack for the following reasons. +VCV is unable to accept free code contributions to Rack for the following reasons. - **Quality.** Most contributions to open-source projects typically only contain code, but writing code is just a small percentage of the effort required to maintain a large software project. Additional tasks for fully supporting a feature include - debating the best design before any code is written - considering all use cases and corner cases of the implementation - generalizability to allow other features to be built on top if needed + - backward compatibility with Rack's plugin [API/ABI](https://vcvrack.com/manual/Version) and user patches. - testing across all supported operating systems and hardware - dedication to support the feature for >4 years - **Time.** @@ -21,8 +22,8 @@ To accept a contribution, all authors of the contribution need to either Except in exceptional circumstances, contributions are only accepted as paid work under detailed guidelines. -However there are several areas you may contribute Rack project. -- [creating high-quality issues](https://vcvrack.com/manual/FAQ.html#i-found-a-bug) -- responding to [issues](https://github.com/VCVRack/Rack/issues) and answering questions in the [VCV communities](https://vcvrack.com/manual/Communities.html) -- [developing and maintaining your own plugins](https://vcvrack.com/manual/PluginDevelopmentTutorial.html) -- contributing to Rack's open-source dependencies, like [GLFW](https://www.glfw.org/), [nanovg](https://github.com/memononen/nanovg), [RtAudio](https://www.music.mcgill.ca/~gary/rtaudio/), and [RtMidi](https://www.music.mcgill.ca/~gary/rtmidi/). +However there are several areas you may volunteer to benefit the Rack project. +- Create proper [bug reports and feature requests](https://vcvrack.com/manual/Issues). +- Answer questions in the [VCV communities](https://vcvrack.com/manual/Communities). +- Develop and maintain your own [Rack plugins](https://vcvrack.com/manual/PluginDevelopmentTutorial). +- Contribute to Rack's open-source dependencies, such as [GLFW](https://www.glfw.org/), [nanovg](https://github.com/memononen/nanovg), [RtAudio](https://www.music.mcgill.ca/~gary/rtaudio/), and [RtMidi](https://www.music.mcgill.ca/~gary/rtmidi/). diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e3c17656..954f5a15 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -18,8 +18,8 @@ like this. ### Details -Operating system: -Rack version: vX.X.X +Operating system and version: +Rack version (vX.Y.Z): Hardware relevant to your issue (e.g. graphic card model, audio/MIDI device): ### Summary diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 27357d55..0cde0c34 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -19,7 +19,7 @@ What is the motivation for this feature? What does the feature achieve? ### Proposed design