Documentation: Backwards compatibility / Deprecation Policy

Open
  • Is something wrong?
#6,779 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
47/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
angular, typescript
Domain
documentation

Research direction

Start by reading the project's documentation and peer dependency declarations to understand what compatibility guarantees are currently stated. Document the deprecation policy and clarify whether projects built with earlier major versions remain supported; done when the documentation explains the guarantee and agrees with the peer dependency policy.

Written by the indexing model from the issue text.

Description

Description:
Documentation should be updated to include deprecation policy. (If a project is made on version 20, is there any guarantee it will work on 21?)

The Angular Deprecation policy is that it will continue to exist for 2 major versions, guaranteeing to be compatible with projects compiled with the previous 2 versions. The Peer dependencies of this project do not reflect that though.

Dominant language
TypeScript
Stars
5.5k
Forks
1.7k
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from valor-software/ngx-bootstrap

All issues in valor-software/ngx-bootstrap

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.