navi/docs/contributions/README.md
alexis-opolka 48fd4db08d Did a bit of refactoring - Deleted the png file inside the repository
Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>
2025-05-04 11:00:43 +02:00

1.8 KiB

Navi contributors

This section is about the ways you can contribute to Navi and its ecosystem.

How to contribute to Navi

You have multiple ways to contribute to navi, here are the documented ones:

Please see each section for more details.

Versioning Scheme

Type Description
Major Anything which introduces a major breaking change. The bash to rust rewrite was such an example.
Minor Almost everything.
Fix A fix, just like its name. It should be micro releases with minimal changes.

Deprecation of features

Once you introduce a feature, you need to have a clear view of when we're going to remove its support within navi.

In order to offer stability to the users, we prefer having 10 minor versions between the deprecation notice and the removal of its support.

Version where the feature is being deprecated: 0.10.0
Version where the support is dropped: 0.20.0

Note

This rule is not absolute and each feature deprecation needs to be handled carefully given its own circumstances, but try to stick as close as possible to this rule.