DOC: Added call out to API guidelines to contribute + small API guidelines reorg #27650
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
story645
force-pushed
the
api-guidelines
branch
from
5186680
to
87f2ffa
Compare
timhoffm
approved these changes
Jan 16, 2024
doc/devel/api_changes.rst
Outdated
| .. _api_whats_new: | ||
|
|
||
| Announce changes, deprecations, and new features | ||
| ------------------------------------------------ | ||
| Announce new features, API changes, and deprecations |
There was a problem hiding this comment.
Take or leave: Announcing is done after one has done the implementation. Therefore I'm slightly in favor of moving this section to the bottom so that the new order is:
- Add new API and features
- Deprecate API
- Announce new features, API changes, and deprecations
There was a problem hiding this comment.
Agree, I think what I've done here is blend overview with the announcement specific relevant stuff, so I may separate that out.
added callout in coding guidelines to make more obvious. Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
story645
force-pushed
the
api-guidelines
branch
from
87f2ffa
to
d0dcd9e
Compare
|
@timhoffm updated it so that the announce section is a bit less overview and pushed it to the bottom. |
timhoffm
approved these changes
Jan 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
Spun docs changes out of #27641 to let that one go through faster. Changes here are:
API->changestoAPI->guidelinesAPI Guidelinesso top level is announce, add new features, deprecatePR checklist