nasa / nasa/cFS

Document deprecation process

Open
#67 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
C
Stars
1.5k
Forks
391
Avg merge
1d 11h
Merged PRs (30d)
19

Description

Is your feature request related to a problem? Please describe.
Process not documented

Describe the solution you'd like
Document process and reference.

  • Issue requesting deprecation gets reviewed by CCB, accepted/assigned or rejected
    • evaluate requirements/documentation/operational impacts
  • Pull request(s) wraps deprecated elements in *_OMIT_DEPRECATED ifndef and removes any internal dependencies
    • Default sample configuration does not remove this code
    • make OMIT_DEPRECATED=true prep will compile without it to check code for compliance
    • ideally any deprecated elements address dependency fix (use new element, no longer supported, etc)
    • elements can be deprecated in any build/release
    • CI tests with and without deprecated elements removed to ensure no internal dependencies
  • Issue requesting removal of deprecated code
  • Pull request removes deprecated elements
    • typically done end of cycle prior to a major release

Describe alternatives you've considered
Wing it.

Additional context
None

Requester Info
Jacob Hageman - NASA/GSFC

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No documentation file is named. Start with the deprecation workflow in this issue, then locate the project documentation and inspect the *_OMIT_DEPRECATED guards, make OMIT_DEPRECATED=true path, and CI coverage described here. Done means the review, deprecation, removal, release timing, and validation steps are documented with their operational impacts.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
build-system, documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.