From 9612cae01312ea34ef0f2b5b0c0b553c7cfd5473 Mon Sep 17 00:00:00 2001 From: CSK <73425927+cr2007@users.noreply.github.com> Date: Sat, 24 Feb 2024 15:51:34 +0400 Subject: [PATCH] docs: Adds Index in the `Contributing.md` file Makes it easier to get to the relevant section of the Docs --- docs/CONTRIBUTING.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 048208f..5b17b28 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,10 +1,25 @@ # 📜 Conventions for contributions -This file contains guidelines for creating *commits, PRs, branches, issues, and etc*. +This file contains guidelines for creating *commits, PRs, branches, issues, and etc*. + +## Index + +- [Commits](#➕-commits) + - [Commit Message Structure](#🗃️-commit-message-structure) + - [Example Commit](#example-commit) + - [Commit Types](#📑-commit-types) + - [Breaking Changes](#❗️-breaking-changes) +- [Branching](#🌳-branching) + - [Example Branch Name](#📄-example-branch-name) +- [Pull Requests (PRs)](#pull-requests-prs) + - [PR message structure](#🗃️-pr-message-structure) + - [Example PR Message](#📄-example-pr-message) > [!NOTE] > **READ BEFORE CONTRIBUTING!**
> If you have any questions on the following information, text me (Adil), I will take you through it. +--- + ## ➕ Commits First, let's answer the questions **"When do I commit? And how many files do I commit at once?"**
@@ -84,6 +99,7 @@ Closes Issue #number-of-the-issue ### 📄 Example PR message --- + ``` Login Page finished