Merge pull request #82 from josephpdf/documentation

Enhance Documentation in the Project #76
ByteBuildersLabs · Oct 30, 2024 · 84db185 · 84db185
2 parents 7261439 + edaf793
commit 84db185
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/.github/templates/ISSUE_TEMPLATE.md b/.github/templates/ISSUE_TEMPLATE.md
@@ -0,0 +1,11 @@
+## Issue
+### 📖 Description
+- Issue description
+### 📓 Summary
+- Brief summary of the issue
+### 📦 Deliverable
+- File or files to deliverable in this issue
+### 📚 References
+- Some references to the repository
+### ⚠️ Notes
+- Important notes for the issue
diff --git a/.github/PULL_REQUEST_TEMPLATE.md → .github/templates/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md → .github/templates/PULL_REQUEST_TEMPLATE.md
diff --git a/README.md b/README.md
@@ -141,8 +141,7 @@ make setup
 ```
 
 ## Contribution 🤝
-
-We welcome contributions from developers of all levels! If you're interested in contributing to this project, please follow our [CONTRIBUTION GUIDELINES](./CONTRIBUTION.md) to get started.
+We welcome contributions from developers of all levels! If you're interested in contributing to this project, please follow our  [CONTRIBUTION GUIDELINES](./docs/contribution/CONTRIBUTION.md) to get started.
 
 Whether it's fixing bugs, improving documentation, or adding new features, your help is greatly appreciated. Don't hesitate to ask questions or reach out for support—we're here to help!
 

diff --git a/CONTRIBUTION.md → docs/contribution/CONTRIBUTION.md b/CONTRIBUTION.md → docs/contribution/CONTRIBUTION.md