@@ -1,77 +1 @@ | |||||
# Contributor Covenant Code of Conduct | |||||
## Our Pledge | |||||
In the interest of fostering an open and welcoming environment, we as | |||||
contributors and maintainers pledge to making participation in our project and | |||||
our community a harassment-free experience for everyone, regardless of age, body | |||||
size, disability, ethnicity, sex characteristics, gender identity and expression, | |||||
level of experience, education, socio-economic status, nationality, personal | |||||
appearance, race, religion, or sexual identity and orientation. | |||||
## Our Standards | |||||
Examples of behavior that contributes to creating a positive environment | |||||
include: | |||||
* Using welcoming and inclusive language | |||||
* Being respectful of differing viewpoints and experiences | |||||
* Gracefully accepting constructive criticism | |||||
* Focusing on what is best for the community | |||||
* Showing empathy towards other community members | |||||
Examples of unacceptable behavior by participants include: | |||||
* The use of sexualized language or imagery and unwelcome sexual attention or | |||||
advances | |||||
* Trolling, insulting/derogatory comments, and personal or political attacks | |||||
* Public or private harassment | |||||
* Publishing others' private information, such as a physical or electronic | |||||
address, without explicit permission | |||||
* Other conduct which could reasonably be considered inappropriate in a | |||||
professional setting | |||||
## Our Responsibilities | |||||
Project maintainers are responsible for clarifying the standards of acceptable | |||||
behavior and are expected to take appropriate and fair corrective action in | |||||
response to any instances of unacceptable behavior. | |||||
Project maintainers have the right and responsibility to remove, edit, or | |||||
reject comments, commits, code, wiki edits, issues, and other contributions | |||||
that are not aligned to this Code of Conduct, or to ban temporarily or | |||||
permanently any contributor for other behaviors that they deem inappropriate, | |||||
threatening, offensive, or harmful. | |||||
## Scope | |||||
This Code of Conduct applies within all project spaces, and it also applies when | |||||
an individual is representing the project or its community in public spaces. | |||||
Examples of representing a project or community include using an official | |||||
project e-mail address, posting via an official social media account, or acting | |||||
as an appointed representative at an online or offline event. Representation of | |||||
a project may be further defined and clarified by project maintainers. | |||||
## Enforcement | |||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | |||||
reported by contacting the project team at contact@vcvrack.com. All | |||||
complaints will be reviewed and investigated and will result in a response that | |||||
is deemed necessary and appropriate to the circumstances. The project team is | |||||
obligated to maintain confidentiality with regard to the reporter of an incident. | |||||
Further details of specific enforcement policies may be posted separately. | |||||
Project maintainers who do not follow or enforce the Code of Conduct in good | |||||
faith may face temporary or permanent repercussions as determined by other | |||||
members of the project's leadership. | |||||
## Attribution | |||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | |||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | |||||
[homepage]: https://www.contributor-covenant.org | |||||
For answers to common questions about this code of conduct, see | |||||
https://www.contributor-covenant.org/faq | |||||
See [VCV Community Rules](https://vcvrack.com/rules). |
@@ -1,19 +1,20 @@ | |||||
VCV Rack is [open-source](https://opensource.org/osd) but not [open-contribution](https://opensource.guide/how-to-contribute/). | 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.** | - **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. | 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 | Additional tasks for fully supporting a feature include | ||||
- debating the best design before any code is written | - debating the best design before any code is written | ||||
- considering all use cases and corner cases of the implementation | - considering all use cases and corner cases of the implementation | ||||
- generalizability to allow other features to be built on top if needed | - 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 | - testing across all supported operating systems and hardware | ||||
- dedication to support the feature for >4 years | - dedication to support the feature for >4 years | ||||
- **Time.** | - **Time.** | ||||
In the past, free code contributions have cost far more time to review, iterate, fix, and test than writing the implementation from scratch. | In the past, free code contributions have cost far more time to review, iterate, fix, and test than writing the implementation from scratch. | ||||
There have been exceptions to this, but they are rare. | There have been exceptions to this, but they are rare. | ||||
- **Legal.** | - **Legal.** | ||||
A proprietary fork of VCV Rack is planned (see [*Rack for DAWs*](https://vcvrack.com/manual/FAQ.html#is-vcv-rack-available-as-a-vst-au-aax-plugin-for-daws)), so VCV must own all GPLv3 code. | |||||
A proprietary fork of VCV Rack is planned (see [*Rack for DAWs*](https://vcvrack.com/manual/FAQ.html#is-vcv-rack-available-as-a-vst-au-aax-plugin-for-daws)), so VCV must own all GPL-licensed code that is included in Rack. | |||||
To accept a contribution, all authors of the contribution need to either | To accept a contribution, all authors of the contribution need to either | ||||
- declare the patch under the [CC0](https://creativecommons.org/publicdomain/zero/1.0/) license. | - declare the patch under the [CC0](https://creativecommons.org/publicdomain/zero/1.0/) license. | ||||
- complete a copyright reassignment form. | - complete a copyright reassignment form. | ||||
@@ -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. | 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/). |
@@ -18,8 +18,8 @@ like this. | |||||
### Details | ### 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): | Hardware relevant to your issue (e.g. graphic card model, audio/MIDI device): | ||||
### Summary | ### Summary | ||||
@@ -19,7 +19,7 @@ What is the motivation for this feature? What does the feature achieve? | |||||
### Proposed design | ### 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. | 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 any corner cases where your implementation would fail? | ||||
Are there alternative implementations? | Are there alternative implementations? | ||||