Skip to content

Latest commit

 

History

History
140 lines (80 loc) · 5.89 KB

VERSION.md

File metadata and controls

140 lines (80 loc) · 5.89 KB

Version Documentation

There are multiple versions of my website. Some are live at the moment, some may not be. Lets discuss a bit about the same.

To skip to the versions tabulation you just may click here 🖱

Table of Contents

Branches & Tags

Branches 🌿

As a rule of thumb, a major version of my website will always be stacked under a branch. For eg, all rollouts under the branch v1 signifies to the version 1 of the website.

Tags 🏷

There may be multiple tags (or releases) under each branch. Each of these release is a minor update adding a stable feature to the branch itself.

About the main branch

Stable Fully Maintained

💡 The main branch signifies the most recent version of the website which is deployed 🚀.

Terms/Keywords

Keywords: Maintainance 🔄 of branch 🌿

Fully Maintained

Only the default branch is fully maintained, which in most cases is the main brach.

Such branches are depicted with a blue 🟦 badge leading with the branch name.

Partially Maintained

Branches which are given such status are only maintained if a contributor spots typos 📝, fixes legacy bugs :bugs:, or broken features 💥. No new features are added to this branch at any time.

Such branches are depicted with a yellow 🟨 badge leading with the branch name.

Actively Maintained

A branch with this status will have high contributions 📈 to it. Contributors add new features ✨, fix bugs 🐛, highlight issues ✉ etc. They submit pull requests which are tested and merged by admins. Simply, this is the most recent version of the website (may be undeployed).

Such branches are depicted with a yellow 🟥 badge leading with the branch name.

  • Stale

Braches are marked stale, as they are considered legacy versions and are for archival purposes. Pull requests will NOT be merged in the branch. A stale branch may still have the website active.

Such branches are depicted with a yellow 🟫 badge leading with the branch name.

Quick Tip(s) 👇🏻

⚠️ Only 1 branch 🌿 can be labeled 🔖 actively maintained & fully maintained respectively.

⚠️ Each branch can have only one status at a time.

Keywords: Stability ⛸ of a branch 🌿

💡 Tip: The main branch is always stable.

1. Stable

A stable branch is considered to be the one deployed, and becomes the a version of the website.

All stable branches are depicited with a green 🟩 badge.

2. Volatile

A volatile branch is considered to be the one where multiple contributions are committed. It should be a high traffic branch 📈. It is this from which some code is merged with a stable branch.

All stable branches are depicited with a green 🟦 badge.

Quick Tips

  1. Volatile branches are mostly actively maintained.
  2. A full maintained branch must be stable and vice versa.

Versions of the site

💡 You can click on the "maintainance" badge to go to the respective branch.

💡 Some badges are clickable. Please hover over them to be sure 🤐.

Version 1

Partially Maintained

Stable

Tags:2 v1.1

Preview

Version 2

🚫 Volatile Braches have no preview.

Actively Maintained

Volatile

Tags:N/A

Current Version

This is the main branch.

Fully Maintained

Stable

Tags:0

Preview

Updates to the version file

The most updated version file will be included in the main branch. To view the same you can click here.