Skip to content

Commit b4b883d

Browse files
authored
Update CONTRIBUTING.md
1 parent 1a65497 commit b4b883d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ us first through the issue tracker with your idea so that we can help out and
1919
possibly guide you. Coordinating up front makes it much easier to avoid
2020
frustration later on.
2121

22+
## Writing a new implementation
23+
24+
Before you start writing a new implementation, look at some of the existing ones. If you copy the
25+
code structure from them, you are more likely to have fewer bugs and an easier review cycle.
26+
27+
If you create new algorithms to encode or decode, then your reviewer will have to spend more time
28+
trying to understand your code in a language they may not be familiar with, and the review cycle
29+
will take longer.
30+
31+
The reason we say this is because once code is accepted into our repository, we have the responsibility
32+
to maintain and look after it. You are not writing the code for you, but for the OLC project team.
33+
2234
## Code reviews
2335
All submissions, including submissions by project members, require review. We
2436
use Github pull requests for this purpose.

0 commit comments

Comments
 (0)