-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Style guide / release checklist for the specification #3785
Comments
|
Thanks @lornajane – yeah I don't think we need to go update every RFC citation, but in some areas where I'm already doing PRs that are thick with them, knowing how to handle references to different sections, some of which happen multiple times, would be really helpful. I'm totally fine with documenting things in the not-contributing file, I've just realized that I'm over capacity and can't take on rewriting that right now even when I'm the person pushing for changes / documented policies :-/ At some point, if no one else steps up, I'll get back to it, but that's multiple months out right now. |
Some pre-release checklist items
Plus some "maybes": |
This is a really great list, that I think we should be expanding to make into a "do it this way" list of style guide directives/tips. We can just keep editing your previous comment and then publish when we're done? |
Something that's important to keep in mind for a style guide / release checklist:
|
We also now have numerous issues about updating this or that reference that really need to be governed by a policy and not ad-hoc discussions: |
Maybe add
|
I ticked off the items about the table of contents since we no longer need that. And I suggest that the versioning wording is something that covers all our needs and unless there's a big problem we identify with it, it shouldn't be a high priority for taking our time and energy. |
As I write PRs, I keep finding little things that I'm not sure how to do. Some examples:
There are other things with less impact (e.g. for bulleted lists do we treat bullet points as sentences or not?), but these are the ones that I hit the most.
The text was updated successfully, but these errors were encountered: