Browse Source

Tweak and update github templates.

pull/1760/head
Andrew Belt 2 years ago
parent
commit
600268ba65
3 changed files with 10 additions and 9 deletions
  1. +7
    -6
      .github/CONTRIBUTING.md
  2. +2
    -2
      .github/ISSUE_TEMPLATE/bug_report.md
  3. +1
    -1
      .github/ISSUE_TEMPLATE/feature_request.md

+ 7
- 6
.github/CONTRIBUTING.md View File

@@ -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/).

+ 2
- 2
.github/ISSUE_TEMPLATE/bug_report.md View File

@@ -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


+ 1
- 1
.github/ISSUE_TEMPLATE/feature_request.md View File

@@ -19,7 +19,7 @@ What is the motivation for this feature? What does the feature achieve?
### Proposed design

<!--
What is one possible implementation of this feature?
What is one possible implementation or design of this feature?
If visual, explain how the user interface should be changed. If interactive, explain the steps needed for a user to use the feature.
Are there any corner cases where your implementation would fail?
Are there alternative implementations?


Loading…
Cancel
Save