Browse Source

Tweak CONTRIBUTING

tags/v1.0.0
Andrew Belt 5 years ago
parent
commit
6b6c85288a
1 changed files with 7 additions and 7 deletions
  1. +7
    -7
      .github/CONTRIBUTING.md

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

@@ -2,17 +2,17 @@
### 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.
Remember that code is easy to write, but inventing a valid design is usually the crux.
Expect 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.
I won't define the exact style here, so just follow the 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.
Use C++11 style, not >=C++14 or C.
This means using the `std::` namespace for stdlib symbols, `std::string` instead of `char*`, `//` comments and `/** */` docstrings, etc.
Avoid 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.
@@ -20,7 +20,7 @@ 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:
Because a proprietary fork of VCV Rack is planned by VCV (*Rack for DAWs*), 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.

Loading…
Cancel
Save