Skip to content

Commit f18e6f1

Browse files
committed
Merge branch 'main' into develop
2 parents 01c53b1 + 38559f9 commit f18e6f1

File tree

4 files changed

+21
-16
lines changed

4 files changed

+21
-16
lines changed

.travis.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ rust:
66

77
env:
88
- TEST_COMMAND=test EXTRA_FLAGS='' FEATURES=''
9-
- TEST_COMMAND=test EXTRA_FLAGS='' FEATURES='yoloproofs'
9+
# Disabled for now along with the yoloproofs feature.
10+
#- TEST_COMMAND=test EXTRA_FLAGS='' FEATURES='yoloproofs'
1011
# run cargo bench with a filter that matches no benchmarks.
1112
# this ensures the benchmarks build but doesn't run them on the CI server.
1213
- TEST_COMMAND=bench EXTRA_FLAGS='"DONTRUNBENCHMARKS"' FEATURES=''

CONTRIBUTING.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,25 @@ of flux.
1010

1111
Currently, the work on the `bulletproofs` crate is in two branches:
1212

13-
* `main`, currently focused on having a production-ready implementation
14-
of the rangeproof protocol;
13+
* `main` holds the latest released version;
1514

16-
* `circuit`, currently focused on exploratory work around circuit
17-
proofs.
15+
* `develop` holds ongoing development work.
1816

19-
Changes affecting the rangeproof parts of the code should be made
20-
against the `main` branch.
17+
Pull requests should be made against `develop`, **not** `main`.
2118

22-
Changes affecting the circuit parts of the code should be made as PRs
23-
against the `circuit` branch. This allows piecewise review of the
24-
circuit code while it's in development, as well as allowing a complete
25-
review when we eventually merge it into the `main` branch.
19+
It's best to start a PR for every in-progress branch so that it's possible
20+
to track all ongoing development work. Adding the `PTAL` (please take a
21+
look) label indicates that the branch is ready for code review.
2622

27-
The `main` branch is regularly merged into the `circuit` branch, so that
28-
the circuit work stays in sync.
23+
## Labels
24+
25+
Labels starting with `T-` are for labeling topics (`T-api`, `T-r1cs`, etc).
26+
27+
The `T-research` label indicates unsolved open problems.
28+
29+
Labels starting with `P-` are for priority levels.
30+
31+
Labels starting with `E-` are for effort estimates.
2932

3033
## CI
3134

Cargo.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "bulletproofs"
3-
version = "1.0.0-pre.0"
3+
version = "1.0.0"
44
authors = ["Cathie Yun <[email protected]>",
55
"Henry de Valence <[email protected]>",
66
"Oleg Andreev <[email protected]>"]
@@ -31,7 +31,8 @@ bincode = "1"
3131

3232
[features]
3333
avx2_backend = ["curve25519-dalek/avx2_backend"]
34-
yoloproofs = []
34+
# Disable the yoloproofs feature for the released crate, so that it's not possible for someone to publish a crate using R1CS proofs yet.
35+
# yoloproofs = []
3536

3637
[[bench]]
3738
name = "range_proof"

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FEATURES := yoloproofs
1+
FEATURES :=
22

33
doc:
44
cargo rustdoc --features "$(FEATURES)" -- --html-in-header docs/assets/rustdoc-include-katex-header.html

0 commit comments

Comments
 (0)