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
Now `origin` refers to my fork and `upstream` refers to the Tendermint version.
76
-
So I can `git push -u origin main` to update my fork, and make pull requests to tendermint from there.
76
+
Now `origin` refers to my fork and `upstream` refers to the CometBFT version.
77
+
So I can `git push -u origin main` to update my fork, and make pull requests to CometBFT from there.
77
78
Of course, replace `ebuchman` with your git handle.
78
79
79
80
To pull in updates from the origin repo, run
@@ -85,7 +86,7 @@ To pull in updates from the origin repo, run
85
86
86
87
We use [go modules](https://github.com/golang/go/wiki/Modules) to manage dependencies.
87
88
88
-
That said, the `main` branch of every Tendermint repository should just build
89
+
That said, the `main` branch of every CometBFT repository should just build
89
90
with `go get`, which means they should be kept up-to-date with their
90
91
dependencies so we can get away with telling people they can just `go get` our
91
92
software.
@@ -100,28 +101,27 @@ up-to-date.
100
101
101
102
When updating dependencies, please only update the particular dependencies you
102
103
need. Instead of running `go get -u=patch`, which will update anything,
103
-
specify exactly the dependency you want to update, eg.
104
-
`GO111MODULE=on go get -u github.com/tendermint/go-amino@master`.
104
+
specify exactly the dependency you want to update.
105
105
106
106
## Protobuf
107
107
108
108
We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along
109
109
with [`gogoproto`](https://github.com/cosmos/gogoproto) to generate code for use
110
-
across Tendermint Core.
110
+
across CometBFT.
111
111
112
112
To generate proto stubs, lint, and check protos for breaking changes, you will
113
113
need to install [buf](https://buf.build/) and `gogoproto`. Then, from the root
114
114
of the repository, run:
115
115
116
116
```bash
117
-
# Lint all of the .proto files in proto/tendermint
117
+
# Lint all of the .proto files
118
118
make proto-lint
119
119
120
120
# Check if any of your local changes (prior to committing to the Git repository)
121
121
# are breaking
122
122
make proto-check-breaking
123
123
124
-
# Generate Go code from the .proto files in proto/tendermint
124
+
# Generate Go code from the .proto files
125
125
make proto-gen
126
126
```
127
127
@@ -149,8 +149,15 @@ If you are a VS Code user, you may want to add the following to your `.vscode/se
149
149
150
150
## Changelog
151
151
152
+
To manage and generate our changelog, we currently use [unclog](https://github.com/informalsystems/unclog).
153
+
152
154
Every fix, improvement, feature, or breaking change should be made in a
153
-
pull-request that includes an update to the `CHANGELOG_PENDING.md` file.
155
+
pull-request that includes a file `.changelog/unreleased/${category}/${issue-or-pr-number}-${description}.md`, where:
156
+
-`category` is one of `improvements`, `breaking-changes`, `bug-fixes`, `features` and if multiple apply, create multiple files;
157
+
-`description` is a short (4 to 6 word), hiphen separated description of the fix, starting the component changed; and,
158
+
- `issue or PR number' is the CometBFT issue number, if one exists, or the PR number, otherwise.
159
+
160
+
For examples, see the [.changelog](.changelog) folder.
154
161
155
162
A feature can also be worked on a feature branch, if its size and/or risk
156
163
justifies it (see #branching-model-and-release) below.
@@ -168,7 +175,7 @@ Some good examples of changelog entry descriptions:
168
175
- [consensus] \#1111 Small transaction throughput improvement (approximately
169
176
3-5\% from preliminary tests) through refactoring the way we use channels
170
177
- [mempool] \#1112 Refactor Go API to be able to easily swap out the current
171
-
mempool implementation in Tendermint forks
178
+
mempool implementation in CometBFT forks
172
179
- [p2p] \#1113 Automatically ban peers when their messages are unsolicited or
173
180
are received too frequently
174
181
```
@@ -242,13 +249,13 @@ easy to reference the pull request where a change was introduced.
242
249
243
250
The latest state of development is on `main`, which must never fail `make test`. _Never_ force push `main`, unless fixing broken git history (which we rarely do anyways).
244
251
245
-
To begin contributing, create a development branch either on `github.com/tendermint/tendermint`, or your fork (using `git remote add origin`).
252
+
To begin contributing, create a development branch either on `github.com/cometbft/cometbft`, or your fork (using `git remote add origin`).
246
253
247
-
Make changes, and before submitting a pull request, update the `CHANGELOG_PENDING.md` to record your change. Also, run either `git rebase` or `git merge` on top of the latest `main`. (Since pull requests are squash-merged, either is fine!)
254
+
Make changes, and before submitting a pull request, update the changelog to record your change. Also, run either `git rebase` or `git merge` on top of the latest `main`. (Since pull requests are squash-merged, either is fine!)
248
255
249
256
Update the `UPGRADING.md` if the change you've made is breaking and the
250
257
instructions should be in place for a user on how he/she can upgrade its
Once you have submitted a pull request label the pull request with either `R:minor`, if the change should be included in the next minor release, or `R:major`, if the change is meant for a major release.
254
261
@@ -282,7 +289,8 @@ After this, you can open a PR. Please note in the PR body if there were merge co
282
289
283
290
### Git Commit Style
284
291
285
-
We follow the [Go style guide on commit messages](https://tip.golang.org/doc/contribute.html#commit_messages). Write concise commits that start with the package name and have a description that finishes the sentence "This change modifies Tendermint to...". For example,
292
+
We follow the [Go style guide on commit messages](https://tip.golang.org/doc/contribute.html#commit_messages). Write concise commits that start with the package
293
+
name and have a description that finishes the sentence "This change modifies CometBFT to...". For example,
286
294
287
295
```sh
288
296
cmd/debug: execute p.Signal only when p is not nil
@@ -314,7 +322,7 @@ Run: `make test_integrations`
314
322
315
323
### End-to-end tests
316
324
317
-
End-to-end tests are used to verify a fully integrated Tendermint network.
325
+
End-to-end tests are used to verify a fully integrated CometBFT network.
318
326
319
327
See [README](./test/e2e/README.md) for details.
320
328
@@ -356,18 +364,6 @@ most probably (99.9%)*.
356
364
`./test/fuzz` directory. See [README.md](./test/fuzz/README.md) for details.
357
365
358
366
Run: `cd test/fuzz && make fuzz-{PACKAGE-COMPONENT}`
359
-
360
-
### Jepsen tests (ADVANCED)
361
-
362
-
*NOTE: if you're just submitting your first PR, you won't need to touch these
363
-
most probably (99.9%)*.
364
-
365
-
[Jepsen](http://jepsen.io/) tests are used to verify the
0 commit comments