Skip to content

Commit

Permalink
docs: Adds Index in the Contributing.md file
Browse files Browse the repository at this point in the history
Makes it easier to get to the relevant section of the Docs
  • Loading branch information
cr2007 authored Feb 24, 2024
1 parent 02f3bbf commit 9612cae
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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!**<br>
> 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?"**
<br>
Expand Down Expand Up @@ -84,6 +99,7 @@ Closes Issue #number-of-the-issue

### 📄 Example PR message
---

```
Login Page finished
Expand Down

0 comments on commit 9612cae

Please sign in to comment.