From c9847344639a6614a2be5acae187ada5eda2a741 Mon Sep 17 00:00:00 2001
From: nashqueue <99758629+nashqueue@users.noreply.github.com>
Date: Tue, 17 Oct 2023 15:16:38 +0200
Subject: [PATCH] (chore): changes to the template for more guidance (#1248)

<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

<!--
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue.
-->

## Checklist

<!--
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords

---------

Co-authored-by: Manav Aggarwal <manavaggarwal1234@gmail.com>
---
 specs/template.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)

diff --git a/specs/template.md b/specs/template.md
index d698e5f5a2b..744798f56b0 100644
--- a/specs/template.md
+++ b/specs/template.md
@@ -35,3 +35,69 @@ rollkit repository rather than in the specification document.
 ## References
 
 List any references used or cited in the document.
+
+## General Tips
+
+### How to use a mermaid diagram that you can display in a markdown
+
+```mermaid
+
+sequenceDiagram
+    title Example
+    participant A
+    participant B
+    A->>B: Example
+    B->>A: Example
+
+ ```
+
+ ```mermaid
+
+graph LR
+    A[Example] --> B[Example]
+    B --> C[Example]
+    C --> A
+
+ ```
+
+ ```mermaid
+
+gantt
+    title Example
+    dateFormat  YYYY-MM-DD
+    section Example
+    A :done,    des1, 2014-01-06,2014-01-08
+    B :done,    des2, 2014-01-06,2014-01-08
+    C :done,    des3, 2014-01-06,2014-01-08
+
+ ```
+
+### Grammer and spelling check
+
+The recommendation is to use your favorite spellchecker extension in your IDE like [grammarly], to make sure that the document is free of spelling and grammar errors.
+
+### Use of links
+
+If you want to use links use proper syntax. This goes for both internal and external links like [documentation] or [external links]
+
+At the bottom of the document in [Reference](#references), you can add the following footnotes that will be visible in the markdown document:
+
+[1] [Grammarly][grammarly]
+
+[2] [Documentation][documentation]
+
+[3] [external links][external links]
+
+Then at the bottom add the actual links that will not be visible in the markdown document:
+
+[grammarly]: https://www.grammarly.com/
+[documentation]: ../README.md
+[external links]: https://github.com/celestiaorg/go-header
+
+### Use of tables
+
+If you are describing variables, components or other things in a structured list that can be described in a table use the following syntax:
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| `name` | `type` | Description |