Browse Source

Merge pull request #88 from o0nd7ots/patch-3

Added markup
pull/90/head
orignal 1 year ago committed by GitHub
parent
commit
66d79dea53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 18
      docs/about/contributing.md

18
docs/about/contributing.md

@ -4,9 +4,15 @@ Contributing @@ -4,9 +4,15 @@ Contributing
Coding guideline
----------------
1. Files from libi2pd must not depend on files from libi2pdclient and i2pd. Files from libi2pdclient can depend on files from libi2pd but not on i2pd. You can find it in the fileslist.mk
2. You can use C++11, but make sure code is buildable by gcc 4.6
3. Don't reinvent a wheel. Try to find appropriate solution in std or boost. If a feature is presented in both, use std.
4. Don't bring any additional dependency without discussion. However boost, openssl and zlib can be used in any amount.
5. No requirements for formatting or coding style. You can do whatever you like.
6. When you work with binary data, mind endianness. Use functions from I2PEndian.h
1. Dependencies
- Files from `libi2pd` must not depend on files from `libi2pdclient` and `i2pd`.
- Files from `libi2pdclient` can depend on files from `libi2pd` but not on `i2pd`.
You can find it in the fileslist.mk
2. You can use C++11, but make sure code is buildable by `gcc 4.6`
3. Don't reinvent a wheel.
- Try to find appropriate solution in std or boost.
- If a feature is presented in both, use std.
5. Don't bring any additional dependency without discussion.
- However `boost`, `openssl` and `zlib` can be used in any amount.
7. No requirements for formatting or coding style. You can do whatever you like.
8. When you work with binary data, mind endianness. Use functions from `I2PEndian.h`

Loading…
Cancel
Save