docs: integrate deprecation guidelines into CONTRIBUTING.md - #3013
Open
william-xue wants to merge 8 commits into
Open
docs: integrate deprecation guidelines into CONTRIBUTING.md#3013william-xue wants to merge 8 commits into
william-xue wants to merge 8 commits into
Conversation
Add a Deprecation Guidelines section to CONTRIBUTING.md summarizing the two-PR deprecation process from doc/about/deprecating.rst, so new contributors can find this information alongside other contributing guidelines. Closes e2nIEE#2974
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #3013 +/- ##
========================================
Coverage 72.12% 72.12%
========================================
Files 355 355
Lines 39376 39376
========================================
Hits 28399 28399
Misses 10977 10977 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Collaborator
|
Thank you for you're PR! Just to let you know we have not forgotten it: No action is required from you. |
…eprecation-guidelines # Conflicts: # CHANGELOG.rst
…eprecation-guidelines # Conflicts: # CHANGELOG.rst
…eprecation-guidelines # Conflicts: # CHANGELOG.rst
…eprecation-guidelines
vogt31337
marked this pull request as draft
July 8, 2026 08:08
…eprecation-guidelines # Conflicts: # CHANGELOG.rst
william-xue
marked this pull request as ready for review
July 13, 2026 02:33
…eprecation-guidelines # Conflicts: # CHANGELOG.rst
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR integrates the deprecation guidelines from the existing documentation into
CONTRIBUTING.md, as requested in #2974.The new section covers:
warnings.warnA changelog entry has also been added.
Test plan
CONTRIBUTING.mdfor accuracy against the source documentationCloses #2974