Skip to content

docs(governance): add deprecation policy for TeachLink Backend - #1740

Merged
RUKAYAT-CODER merged 1 commit into
rinafcode:mainfrom
ghost-cy829:feat/1622-deprecation-policy
Sep 29, 2026
Merged

RUKAYAT-CODER merged 1 commit into
rinafcode:mainfrom
ghost-cy829:feat/1622-deprecation-policy

Conversation

@ghost-cy829

Copy link
Copy Markdown

Closes #1622

This PR adds Governance/policies/DEPRECATION.md, the general deprecation policy for TeachLink Backend, covering the deprecation notice period, the communication channels a deprecation must be announced through, and the criteria that must be met before something can actually be removed, as requested in the issue's implementation plan. It also adds one line to the Policies index in Governance/README.md linking to the new file, in the same style as the other entries there.

The repository already has a detailed domains/API_DEPRECATION.md that governs deprecation of REST endpoints, response fields, and SDK methods specifically. Rather than duplicate that, the new policy explicitly defers to it for API surfaces and instead covers everything else that the project exposes to contributors or other modules: configuration options and environment variables, internal modules and services used across module boundaries, documented scripts and CLI commands, and governance documents themselves.

This change touches exactly two files, and both are inside the Governance folder. No application code, no tests, and no CI configuration were changed.

On verification: every relative link in both files was checked against the current repository and resolves correctly. No regression test was added, because Jest's rootDir is set to src, which is outside the Governance-only scope this issue requires, and there is no existing test in the repo that checks the Governance folder's contents, so there was nothing applicable to update.

I was not able to run lint:ci, typecheck, or build locally. Running pnpm install --frozen-lockfile fails on a completely unmodified checkout of main with ERR_PNPM_LOCKFILE_CONFIG_MISMATCH, and I confirmed this by reproducing the same error with this change stashed out, so it is a pre-existing issue in the repository unrelated to this change. Since this repo's CI pipeline runs lint:ci, typecheck, and build in a clean environment on every PR, those checks will run there.

@drips-wave

drips-wave Bot commented Sep 29, 2026

Copy link
Copy Markdown

@ghost-cy829 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

Adds Governance/policies/DEPRECATION.md covering the deprecation notice period, communication channels, and removal criteria, and links it from the Policies index in Governance/README.md. Defers to the existing domains/API_DEPRECATION.md for API-surface deprecations.

Closes rinafcode#1622
@ghost-cy829
ghost-cy829 force-pushed the feat/1622-deprecation-policy branch from 999fe44 to dd5b9be Compare September 29, 2026 12:00
@RUKAYAT-CODER

Copy link
Copy Markdown
Contributor

Thank you for contributing to the project.

@RUKAYAT-CODER
RUKAYAT-CODER merged commit 9517c19 into rinafcode:main Sep 29, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a deprecation policy for TeachLink Backend

2 participants