From 018378ec932a57784067674cacf7f24fffd48797 Mon Sep 17 00:00:00 2001
From: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>
Date: Sat, 29 Mar 2025 12:43:50 +0100
Subject: [PATCH] Introduce a developers documentation entry

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>
---
 docs/developers/README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 docs/developers/README.md

diff --git a/docs/developers/README.md b/docs/developers/README.md
new file mode 100644
index 0000000..92de8e9
--- /dev/null
+++ b/docs/developers/README.md
@@ -0,0 +1,30 @@
+# Developers documentation
+
+This documentation entry is destined to contributors of the navi project
+and open-source repository.
+
+## 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.
+
+````txt
+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.