You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+32-2Lines changed: 32 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,7 @@ These are not the only factors taken into account when considering to add new fu
26
26
The proposed new libsecp256k1 code must be of high quality, including API documentation and tests, as well as featuring a misuse-resistant API design.
27
27
28
28
We recommend reaching out to other contributors (see [Communication Channels](#communication-channels)) and get feedback before implementing new functionality.
29
+
29
30
## Communication Channels
30
31
31
32
Most communication about libsecp256k1 occurs on the GitHub repository: in issues, pull request or on the discussion board.
@@ -37,9 +38,28 @@ Chat history logs can be found at https://gnusha.org/secp256k1/.
37
38
38
39
## Contributor Workflow & Peer Review
39
40
40
-
The Contributor Workflow & Peer Review in libsecp256k1 are similar to Bitcoin Core's workflow and review processes described in Core's [CONTRIBUTING.md](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md).
41
+
The Contributor Workflow & Peer Review in libsecp256k1 are similar to Bitcoin Core's workflow and review processes described in its [CONTRIBUTING.md](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md).
42
+
43
+
### Coding Conventions
44
+
45
+
In addition, libsecp256k1 tries to maintain the following coding conventions:
46
+
47
+
- No runtime heap allocation (e.g., no `malloc`).
48
+
- The tests should cover all lines and branches of the library (see [Test coverage](#coverage)).
49
+
- Operations involving secret data should be tested for being constant time with respect to the secrets (see [src/ctime_tests.c](src/ctime_tests.c)).
50
+
- Local variables containing secret data should be cleared explicitly to try to delete secrets from memory.
51
+
- Use `secp256k1_memcmp_var` instead of `memcmp` (see [#823](https://github.com/bitcoin-core/secp256k1/issues/823)).
52
+
- Arguments of the publicly-facing API must have a specific order defined in [include/secp256k1.h](include/secp256k1.h).
53
+
54
+
#### Style Conventions
55
+
56
+
- Commits should be atomic and diffs should be easy to read. For this reason, do not mix any formatting fixes or code moves with actual code changes. Make sure each individual commit is hygienic: that it builds successfully on its own without warnings, errors, regressions, or test failures.
57
+
- Use `void *ptr` instead of `void* ptr`.
58
+
- Avoid trailing whitespaces.
41
59
42
-
### Test coverage
60
+
### Tests
61
+
62
+
#### Coverage
43
63
44
64
This library aims to have full coverage of the reachable lines and branches.
45
65
@@ -59,3 +79,13 @@ To create a HTML report with coloured and annotated source code:
0 commit comments