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

Added deprecation guidelines #70

Merged
merged 2 commits into from
May 15, 2024
Merged

Added deprecation guidelines #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42accd1
Added deprecation guidelines
AustinSanders May 10, 2024
d52cd37
Merge branch 'main' into developer_references_deprecation
AustinSanders May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/how-to-guides/software-management/deprecation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Deprecation
This document is intended to provide guidelines for the deprecation process.

## 1. Deprecation Proposal
Those who wish to deprecate functionality should propose the deprecation via an issue on the software's repository of record. This allows for discussion among the developers and the user community. If a consensus is met that the functionality should be deprecated, then a deprecation warning should be written.

## 2. Deprecation Warning
A deprecation warning should be presented to the user whenever the deprecated functionality is used. Though no standard has yet been agreed upon by the developers or the ASC software user base, previous deprecation warnings have taken the form of a simple message printed via `cout`. In addition to creating the deprecation warning message, the deprecated functionality should also be noted in the repository's changelog. This warning should include a link to the issue that proposed the deprecation.

## 3. Removal of Deprecated Functionality
No less than 6 months after the release that includes the deprecation notice, a commit containing the removal of the deprecated functionality should be PR'd into the development branch. This change should also be captured in the changelog.
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ nav:
- General Utility with FX: how-to-guides/image-processing/general-utility-with-fx.md
- Bundle Adjustment in ISIS: how-to-guides/image-processing/bundle-adjustment-in-isis.md
- Software Management:
- Deprecation: how-to-guides/software-management/deprecation.md
- Public Release Process: how-to-guides/software-management/public-release-process.md
- Software Support: how-to-guides/software-management/software-support.md
- Guidelines for Reporting Issues: how-to-guides/software-management/guidelines-for-reporting-issues.md
Expand Down
Loading