8000 RFC Proposal Path by prince-chrismc · Pull Request #462 · pyrsia/pyrsia · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

RFC Proposal Path #462

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.

Sign up for GitHub

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

Merged
merged 17 commits into from
Apr 14, 2022
Merged

RFC Proposal Path #462

merged 17 commits into from
Apr 14, 2022

Conversation

prince-chrismc
Copy link
Contributor

As discussed in our retro, we need to formally have a processes

  • This is taken deeply from Rust, Python, and React Native existing templates

We'll need to prioritize writing the proposals that we made verbally.

My goal is to fold this into the new website's documentation under the "Developer Hub".
I might tweak the header of the template to render better on the website.

@prince-chrismc prince-chrismc added the documentation Improvements or additions to documentation label Mar 5, 2022
@prince-chrismc prince-chrismc requested review from a team, efrisch and chb0github and removed request for a team March 5, 2022 00:28
@prince-chrismc prince-chrismc self-assigned this Mar 5, 2022
@codecov
Copy link
codecov bot commented Mar 5, 2022

Codecov Report

Merging #462 (197e5ab) into main (677cb7a) will increase coverage by 1.53%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #462      +/-   ##
==========================================
+ Coverage   59.61%   61.15%   +1.53%     
==========================================
  Files          26       31       +5     
  Lines        1768     1964     +196     
==========================================
+ Hits         1054     1201     +147     
- Misses        714      763      +49     
Impacted Files Coverage Δ
src/network/p2p.rs 0.00% <0.00%> (ø)
src/docker/v2/handlers/blobs.rs 0.00% <0.00%> (ø)
src/blockchain/src/blockchain.rs 0.00% <0.00%> (ø)
src/network/handlers.rs
src/network/artifact_protocol.rs 0.00% <0.00%> (ø)
src/util/keypair_util.rs 73.91% <0.00%> (ø)
src/network/event_loop.rs 0.00% <0.00%> (ø)
src/network/behaviour.rs 0.00% <0.00%> (ø)
src/network/client.rs 94.16% <0.00%> (ø)
src/network/client/command.rs 0.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 677cb7a...197e5ab. Read the comment docs.

@chb0github
Copy link
Contributor

What ticket does this address?

chb0github
chb0github previously approved these changes Mar 8, 2022
Copy link
Contributor
@chb0github chb0github left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have much of an opinion on how to define an RFC template

@prince-chrismc
Copy link
Contributor Author

What ticket does this address?

This was an action item from the standup ❤️

@erwin1
Copy link
Member
erwin1 commented Mar 8, 2022

I read through it, looks like a very good starting point.
I just had this one minor question above.

@mseabornIBM
Copy link
Contributor

I think the RFC approach is good. I also believe, as is outlined in the process, that getting consensus on ideas is an important phase of proposal. Does it make sense to have a step before your RFC process steps that is a small white paper about the idea before it is committed to the RFC process?

@prince-chrismc
Copy link
Contributor Author

Does it make sense to have a step before your RFC process steps that is a small white paper about the idea before it is committed to the RFC process?

I tried to cover this in

https://github.com/prince-chrismc/pyrsia-sandbox/tree/proposal-path/docs/rfc#before-creating-an-rfc

The most common preparations for writing and submitting an RFC include talking the idea over on our official Slack channel, discussing the topic in a GitHub issue.

Perhaps is a little unclear or hidden?

@prince-chrismc
Copy link
Contributor Author

Perhaps is a little unclear or hidden?

Looking it over, i felt it could be improved!

https://github.com/prince-chrismc/pyrsia-sandbox/blob/proposal-path/docs/rfc/readme.md#summary

Thanks for the input 👏

erwin1
erwin1 previously approved these changes Mar 9, 2022
@prince-chrismc prince-chrismc marked this pull request as ready for review March 11, 2022 00:34
efrisch
efrisch previously approved these changes Mar 14, 2022
Copy link
Member
@efrisch efrisch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. 👍

@betarelease
Copy link
Member

I was reading through this and the references from RUST community.

For our small team and purpose this is very detailed and has too many required sections.

I would like this to be simplified as

TL;DR
What is the Issue?
Solutions available
Proposed Solution
Comments

And provide references in case we are making such a fundamental change that other sections may make sense and let the proposer choose to add sections.

In general reduce the barrier for people to submit proposals, but give them a little bit of structure.

Copy link
Member
@betarelease betarelease left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was reading through this and the references from RUST community.

For our small team and purpose this is very detailed and has too many required sections.

I would like this to be simplified as

TL;DR
What is the Issue?
Solutions available
Proposed Solution
Comments

And provide references in case we are making such a fundamental change that other sections may make sense and let the proposer choose to add sections.

In general reduce the barrier for people to submit proposals, but give them a little bit of structure.

@prince-chrismc
Copy link
Contributor Author

@betarelease it's unlear if you are referring to the template of the proposal workflow 😕

Which file (or both) so I take that feedback into account for?

Copy link
Member
@betarelease betarelease left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added comments inline to clarify which parts of the process flow I felt were too demanding/constraining.

Similarly any language that puts too many constraints on including people into the team should be cleaned up.

Copy link
Member
@betarelease betarelease left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few more comments in places where I found the template too demanding or too strict.


# Future possibilities

Think about what the natural extension and evolution of your proposal would
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph is too much to ask from a proposer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made this sectional optional but I like the idea to leave space for anything extra the author might want to add

Is that a good middle ground?

Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com>
@prince-chrismc prince-chrismc dismissed stale reviews from efrisch and erwin1 via bf7dc71 March 21, 2022 17:26
Chris Mc and others added 2 commits March 21, 2022 10:33
and less restrictive


Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com>
Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com>
AbhijithGanesh and others added 3 commits March 28, 2022 19:55
Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com>
Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com>
Copy link
Member
@efrisch efrisch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Member
@fishseabowl fishseabowl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 😄

@prince-chrismc prince-chrismc merged commit f1def60 into pyrsia:main Apr 14, 2022
@prince-chrismc prince-chrismc deleted the proposal-path branch April 14, 2022 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants
0