Merge pull request #78 from dscyrescotti/docs/readme-revamp

[Docs] Set up Github templates

.github/ISSUE_TEMPLATE/bug-report.md

@@ -7,26 +7,28 @@ assignees: ''
 
 ---
 
-**Description**
-A clear and concise description of what the bug is.
+### Description
+<!-- A clear and concise description of what the bug is. -->
 
-**Steps to reproduce**
+### Steps to reproduce
+<!-- 
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
+-->
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+### Expected behavior
+<!-- A clear and concise description of what you expected to happen. -->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+### Screenshots
+<!-- If applicable, add screenshots to help explain your problem. -->
 
-**Device (please complete the following information):**
- - OS: [e.g. iOS]
- - Model: [e.g. iPhone13]
- - Version [e.g. v1.0.1]
+### Device (please complete the following information)
+ - OS: <!-- [e.g. iOS] -->
+ - Model: <!-- [e.g. iPhone13] -->
+ - Version <!-- [e.g. v1.0.1] -->
 
-**Additional context**
-Add any other context about the problem here.
+### Additional context
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -7,14 +7,14 @@ assignees: ''
 
 ---
 
-**Backstory**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+### Backstory
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when ... -->
 
-**Proposal**
-A clear and concise description of what you want to happen.
+### Proposal
+<!-- A clear and concise description of what you want to happen. -->
 
-**Alternative**
-A clear and concise description of any alternative solutions or features you've considered.
+### Alternative
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Addition**
-Add any other context or screenshots about the feature request here, if applicable.
+### Addition Context
+<!-- Add any other context or screenshots about the feature request here, if applicable. -->

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+### Description
+
+<!--- REQUIRED: Describe what changed in detail -->
+
+### Related Issues
+
+<!--- REQUIRED: Tag all related issues (e.g. * #123) -->
+<!--- If this PR resolves the issue please specify (e.g. * closes #123) -->
+<!--- If this PR addresses multiple issues, these issues must be related to one other -->
+
+* #ISSUE_NUMBER
+
+### Checklist
+
+<!--- Add things that are not yet implemented above -->
+
+- [ ] I read and understood the [contributing guide](https://github.com/dscyrescotti/Memola/blob/main/CONTRIBUTING.md) as well as the [code of conduct](https://github.com/dscyrescotti/Memola/blob/main/CODE_OF_CONDUCT.md)
+- [ ] The issues this PR addresses are related to each other
+- [ ] My changes generate no new warnings
+- [ ] My code builds and runs on my machine
+- [ ] My changes are all related to the related issue above
+
+### Screenshots
+
+<!--- REQUIRED: if issue is UI related -->
+
+<!--- IMPORTANT: Fill out all required fields. Otherwise we might close this PR temporarily -->

README.md

@@ -5,25 +5,28 @@
     </h1>
     <div>
         <a href="https://apps.apple.com/app/memola/id6738171174">
-            <img height="40px" src="Assets/ios-app-store.svg">
+            <img height="35px" src="Assets/ios-app-store.svg">
         </a>
         <a href="https://apps.apple.com/app/memola/id6738171174">
-            <img height="40px" src="Assets/mac-app-store.svg">
+            <img height="35px" src="Assets/mac-app-store.svg">
         </a>
     </div>
 </div>
 <br>
 
-**Memola** is an open-source note-taking application, fully built using the Metal framework, allowing you to seamlessly jot down ideas and sketch your visions across iOS, iPadOS, and macOS.
+Memola is an open-source note-taking application, fully built using the Metal framework, allowing you to seamlessly jot down ideas and sketch your visions across iOS, iPadOS, and macOS.
 
 <p align="center">
 <img width="100%" src="Assets/app-demo.png">
 </p>
 
-## 👨‍💻 Contributions
+## Motivation
+Metal is a fascinating framework where we can leverage the optimal power of GPUs through compute shaders and rendering shaders to build advanced applications powered by GPUs. This raised multiple questions like "How is the render pipeline constructed?" and "How are renders generated?", which led to an adventurous journey of crafting a 2D render engine. That's how this project, Memola, started to dive into the world of GPU programming.  
+
+## Contributing
 **Memola** welcomes all developers to contribute if you have any idea to enhance and open an issue if you encounter any bug.
 
-## 🙇 Credits
+## Credits
 - [BezierKit](https://github.com/hfutrell/BezierKit)
 - [FastDraw](https://github.com/collinzrj/FastDraw)
 - [hand-drawing-swift-metal](https://github.com/owengombas/hand-drawing-swift-metal)
@@ -37,5 +40,5 @@
 - [Sketch](https://github.com/daihase/Sketch)
 - [THST](https://github.com/tuxalin/THST)
 
-## © License
-**Memola** is available under the MIT license. See the [LICENSE](/LICENSE) file for more info.
+## License
+Memola is available under the MIT license. See the [LICENSE](/LICENSE) file for more info.