-
Notifications
You must be signed in to change notification settings - Fork 34
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
Improve docs around releases #79
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.
great additions!
highlighting for a future effort: still to capture is the process around major version releases (e.g., creating new major version branches, beta releases, eventual sunsetting of support for old major versions, etc.). this may be exclusive to web3.py, or at least driven by web3.py, and therefore that process may only need documenting in the Contributing docs of web3.py.
Opened ethereum/web3.py#3115 to fill in the details for major releases. |
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.
Looks great. I'd add a Rebase and merge
option to the Squash and merge
section you added. Most times for me, that's the most relevant way to merge. Some minor nits as well on the raw md.
This needed some modernizing so thanks for taking that on 👌🏼
Co-authored-by: felipe <[email protected]>
Revamped the release guide, mainly to outline our process and agreements. While I was there I simplified the steps for the most common approach and moved the ancillary notes into a new FAQ section.