From 74ffc607e60c3dcb7360a23b078695d72c22f6d8 Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Mon, 10 Jun 2019 10:15:19 -0400 Subject: [PATCH] Add CONTRIBUTING.md. --- .github/CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..d4ee0373 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,26 @@ + +### Pre-implementation + +Before authoring a code contribution, open an issue explaining your proposal in detail. +Remember that code is easy to write, but a valid design is usually the crux. +Expect for the proposal to be rejected if you do not consider 100% of use-cases and corner cases. + +### Code style and quality + +Be courteous and try to match the code style. +I won't define the exact style here, so just look at existing code. + +Use C++11 style, not C++future or C. +This means using the `std::` namespace for stdlib symbols, `std::string` instead of `char*`, etc. +Avoid pointlessly over-engineered things like `iostream`, `std::array`, `std::unique_ptr`, etc when simpler alternatives exist. + +Write maintainable code that will last >4 years. +No feature/bug is urgent enough to write dirty/temporary implementations. +I have no need to withdraw technical debt. + +### Legal + +Because a proprietary fork of VCV Rack (i.e. *Rack for DAWs*) is planned by VCV, in order for your patch to be accepted, you must make a declaration stating that: +- you are the sole author of your patch. +- your patch is released under the [CC0](https://creativecommons.org/publicdomain/zero/1.0/) license. +- or ask for a copyright reassignment form if you prefer this instead.