Skip to content
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

Jump to bottom

Surface Links to Stability Policy #2847

Closed
sco1 opened this issue Jan 31, 2022 · 2 comments · Fixed by #2848
Closed

Surface Links to Stability Policy #2847

sco1 opened this issue Jan 31, 2022 · 2 comments · Fixed by #2848
Labels
good first issue Good for newcomers S: accepted The changes in this design / enhancement issue have been accepted and can be implemented T: documentation Improvements to the docs (e.g. new topic, correction, etc)

Comments

@sco1
Copy link
Contributor

sco1 commented Jan 31, 2022

The changelog for v22.1.0 mention the new stability policy (yay!):

At long last, Black is no longer a beta product! This is the first non-beta release and the first release covered by our new stability policy.

But there isn't a link to the policy anywhere overt. I ended up going to the PR to see where it was added into the documentation. Would it be reasonable to add this link to the changelog, and perhaps also the README?
@sco1 sco1 added the T: documentation Improvements to the docs (e.g. new topic, correction, etc) label Jan 31, 2022
@ichard26 ichard26 added good first issue Good for newcomers S: accepted The changes in this design / enhancement issue have been accepted and can be implemented labels Jan 31, 2022
@ichard26
Copy link
Collaborator

There's actually no reference to the stability policy in the README at all. The documentation home page does technically link it but it might be good to make it more visible. I'll fix the GH release description right now though! Thanks for catching this!

@JelleZijlstra
Copy link
Collaborator

Yes, good idea! I was too lazy to figure out how to link it when I wrote the changelog entry :)

@sco1 sco1 mentioned this issue Jan 31, 2022
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers S: accepted The changes in this design / enhancement issue have been accepted and can be implemented T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Surface links to Stability Policy
3 participants
@JelleZijlstra @sco1 @ichard26