milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Merge Refactor and One ACK carve outs 

The "One ACK carve-out" has 3 rules and then there is a separate
"Refactor carve-out" that covers things that are not only refactoring -
this makes it hard to reference the carve-outs in github because its a
bit confusing.

Merge the carve-outs into a single "one ACK carve-out" with multiple
rules. Use rule 0 for the original refactor carve-out stuff because it
makes the diff smaller and all good lists start with 0.

Also remove mention of the refactor carve-out from rule 3.
This commit is contained in:
Tobin C. Harding 2024-03-23 07:17:52 +11:00
parent ebf5b670d4
commit 42d02fbd66
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -144,21 +144,18 @@ Current list of the project maintainers:
- [Riccardo Casatta](https://github.com/RCasatta) - [Riccardo Casatta](https://github.com/RCasatta)
- [Tobin Harding](https://github.com/tcharding) - [Tobin Harding](https://github.com/tcharding)
#### Refactor carve-out #### One ACK carve-out
The repository is going through heavy refactoring and "trivial" API redesign The repository is going through heavy refactoring and "trivial" API redesign
(eg, rename `Foo::empty` to `Foo::new`) as we push towards API stabilization. As (eg, rename `Foo::empty` to `Foo::new`) as we push towards API stabilization. As
such reviewers are either bored or overloaded with notifications, hence we have such reviewers are either bored or overloaded with notifications, hence we have
created a carve out to the 2-ACK rule. created a carve out to the 2-ACK rule.
A PR may be considered for merge if it has a single ACK and has sat open for at
least two weeks with no comments, questions, or NACKs.
#### One ACK carve-out
We reserve the right to merge PRs with a single ACK [0], at any time, if they match We reserve the right to merge PRs with a single ACK [0], at any time, if they match
any of the following conditions: any of the following conditions:
0. PR has a single ACK and has sat open for at least two weeks with no comments,
questions, or NACKs.
1. PR only touches CI i.e, only changes any of the test scripts and/or 1. PR only touches CI i.e, only changes any of the test scripts and/or
stuff in `.github/workflows`. stuff in `.github/workflows`.
2. Non-content changing documentation fixes i.e., grammar/typos, spelling, full 2. Non-content changing documentation fixes i.e., grammar/typos, spelling, full
@ -166,8 +163,8 @@ any of the following conditions:
ACKs. ACKs.
3. Code moves that do not change the API e.g., moving error types to a private 3. Code moves that do not change the API e.g., moving error types to a private
submodule and re-exporting them from the original module. Must not include submodule and re-exporting them from the original module. Must not include
any code changes except to import paths. This rule is more restrictive than any code changes except to import paths. Requires absolutely no change to the
the refactor carve-out. It requires absolutely no change to the public API. public API.
[0] - Obviously author and ACK'er must not be the same person. [0] - Obviously author and ACK'er must not be the same person.