-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Describe RFC process #1
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM after adding necessary info in TODOs:
First TODO with examples: you can use the ones that we've discussed today.
- Services isolation. A major improvement which is aimed at separating storage and execution environments of services.
- Transaction finality. Adding additional mechanisms for transaction finalization without inclusion to a blockchain.
- Code parallelization. Make Exonum able to run on several cores simultaneously.
Second todo: probably need something similar for "motion for final comment period" as in Rust and also info about when the number is attached.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly good, but I think RFC licensing needs to be reworked - it may be too restrictive in certain scenarios.
[Exonum RFCs]: #exonum-rfcs | ||
|
||
Exonum RFC process is partially derived from [the Rust RFC process](https://github.com/rust-lang/rfcs/blob/master/README.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn't find out the license for the Rust RFCs. Are you sure we can use it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to this comment rust-lang/rfcs#1259 (comment), we are not first.
More info on rust-lang/rfcs
licensing:
https://github.com/rust-lang/rfcs/blob/master/text/2044-license-rfcs.md
rust-lang/rfcs#2075
README.md
Outdated
following. | ||
|
||
- API changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent indentation with other lists. Also: what does "API changes" entail? Changes in the public interface of the exonum
crate?
README.md
Outdated
request. | ||
|
||
Maintainers of related repositories makes final decisions about RFCs after the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick: s/makes/make/
README.md
Outdated
|
||
[RFC issue tracker]: https://github.com/exonum/rfcs/issues | ||
[RFC repository]: https://github.com/exonum/rfcs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick: unnecessary spacing.
README.md
Outdated
|
||
The Exonum RFCs are licensed under the Creative Commons Non-Commercial | ||
Share-Alike International License (version 4.0). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you sure this is a good choice? Compare with BIP licensing.
README.md
Outdated
|
||
The "RFC" (request for comments) process is intended to provide a consistent | ||
and controlled path for new features to enter the Exonum, so that all |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "RFC" (request for comments) process
(Request for Comments)
new features to enter the Exonum
delete "the"
README.md
Outdated
- Adding new features. | ||
- Removing existing features. | ||
- Changing feature behavior. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changing features behavior. - sounds better due to parallel contructions in the list
README.md
Outdated
- Additions that strictly improve objective, numerical quality criteria | ||
(warning removal, speedup, better platform coverage, more parallelism, trap | ||
more errors, etc.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
better platform coverage, more parallelism, trap more errors, etc.
better rephrase somewhat like "enhanced platform coverage, parallelism, errors trapping, etc."
README.md
Outdated
more errors, etc.) | ||
- Additions only likely to be _noticed by_ other developers-of-exonum, | ||
invisible to users-of-exonum. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Additions are only likely...
README.md
Outdated
[Before creating an RFC]: #before-creating-an-rfc | ||
|
||
A hastily-proposed RFC can hurt its chances of acceptance. Low quality |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A hastily-proposed RFC can hurt its chances of acceptance.
A hastily-proposed RFC can abate chances of its acceptance.
README.md
Outdated
Although there is no single way to prepare for submitting an RFC, it is | ||
generally a good idea to pursue feedback from other project developers | ||
beforehand, to ascertain that the RFC may be desirable; having a consistent |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
beforehand, to ascertain that
eliminate ","
README.md
Outdated
- Fork the RFC repo [RFC repository] | ||
- Copy `0000-template.md` to `text/0000-my-feature.md` (where "my-feature" is | ||
descriptive. don't assign an RFC number yet). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
don't assign an RFC number yet
"Don't"; eliminate "an"; better "just yet"
README.md
Outdated
feedback from the larger community, and the author should be prepared to | ||
revise it in response. | ||
- Build consensus and integrate feedback. RFCs that have broad support are |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a broad support
README.md
Outdated
- This step is taken when enough of the tradeoffs have been discussed that | ||
the maintainers of related repositories are in a position to make a | ||
decision. That does not require consensus amongst all participants in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
enough of the tradeoffs -->
enough tradeoffs
that the maintainers of related repositories are in a position to make a decision. -->
and the maintainers of the related repositories are in position to make the decision.
README.md
Outdated
the disposition on the RFC needs to have already been clearly articulated, | ||
and there should not be a strong consensus *against* that position. | ||
Maintainers of related repositories use their best judgment in taking this |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maintainers of related repositories -->
The maintainers of the related repositories
README.md
Outdated
and major tradeoffs/points of disagreement. | ||
- Before actually entering FCP, *all* maintainers of related repositories | ||
must sign off. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all maintainers of related repositories must sign off -->
the maintainers of the related repositories
README.md
Outdated
days. This way all | ||
stakeholders have a chance to lodge any final objections before a decision | ||
is reached. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
before a decision is reached. -->
the decision
README.md
Outdated
team uses for all issues in the Exonum repository. | ||
|
||
The author of an RFC is not obligated to implement it. Of course, the RFC |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
an RFC --> the RFC
README.md
Outdated
is "no", then the appropriate response is to close the RFC, not postpone it.) | ||
|
||
## Help this is all too informal! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO "Help! This...." looks better
README.md
Outdated
- [Implementing an RFC] | ||
- [RFC Postponement] | ||
- [Help this is all too informal!] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO "Help! This...." looks better
README.md
Outdated
Some changes do not require an RFC: | ||
|
||
- Rephrasing, reorganizing, refactoring, or otherwise "changing shape does |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
otherwise --> "in other words"
README.md
Outdated
poorly-received. | ||
- Submit a pull request. As a pull request the RFC will receive design | ||
feedback from the larger community, and the author should be prepared to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the larger community -->
a larger...
No description provided.