info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-09 12:30:41 +02:00
Code Issues Releases Wiki Activity

Restructure files

Browse Source
This commit is contained in:
Kyle Lobo
2019-07-24 00:51:28 +05:30
parent c40fbafd2f
commit fbaafd3bd1
16 changed files with 0 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
en/CHANGELOG.md Normal file
View File

@@ -0,0 +1,50 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased] - yyyy-mm-dd
Here we write upgrading notes for brands. It's a team effort to make them as
straightforward as possible.
### Added
- [PROJECTNAME-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX)
MINOR Ticket title goes here.
- [PROJECTNAME-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY)
PATCH Ticket title goes here.
### Changed
### Fixed
## [1.2.4] - 2017-03-15
Here we would have the update steps for 1.2.4 for people to follow.
### Added
### Changed
- [PROJECTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ)
PATCH Drupal.org is now used for composer.
### Fixed
- [PROJECTNAME-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT)
PATCH Add logic to runsheet teaser delete to delete corresponding
schedule cards.
## [1.2.3] - 2017-03-14
### Added
### Changed
### Fixed
- [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU)
MINOR Fix module foo tests
- [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR)
MAJOR Module foo's timeline uses the browser timezone for date resolution

41
en/CODEBASE_STRUCTURE.md Normal file
View File

@@ -0,0 +1,41 @@
These are the directories that we are actively using in the development:
+ [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers):
The controllers do the business logic and expose the server API.
+ [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Libraries and
utilities.
+ [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data
Access Objects [DAO] and Value Objects [VO]. Classes used to represent database schemes and facilitate their use by the controllers.
+ [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Smarty templates
used to generate the HTML that is displayed to users.
+ [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): The complete contents of the
Internet page.
### frontend / www
Content:
+ js /
+ css /
#### js
As the name implies, here is where all the javascript fonts and javascript frameworks reside. When you want to make changes, please minify the javascript and then upload.
#### css
Similar to js, here are the minified css files.
### frontend / server
Content:
* dao /
* controllers /
None of these modules should be accessible to the outside world. The only one that can call them is the user interface. That's why they're under the www folder.
#### DAO / VO
The *dao* folder contains the classes for the data access layer. It has 2 things to know: *data access objects* and *value objects*. The *value objects* (VO) are nothing much but classes that are mapped directly to each of the tables in the database. Therefore, there is a class in there called Users, since there is a table with the same name. This class has its setters and getters for each of the fields in the database. The *data access objects* (dao) are static classes for each of the tables, and they serve to obtain and make the objects persistent *vo*.
[Here is more info about this model](http://www.ibm.com/developerworks/java/library/j-dao/)
#### Controllers
The controllers are where the decisions are made. The controller uses the dao's and vo's to make decisions, and never call the database directly. This way, we avoid having separate controllers for each module of the project.

76
en/CODE_OF_CONDUCT.md Normal file
View File

@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at kylelobo20@gmail.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

22
en/CODING_GUIDELINES.md Normal file
View File

@@ -0,0 +1,22 @@
# Coding Guidelines
- You can validate that your code complies with these guidelines by running `stuff/php-format.py validate`
- Tabs, no spaces
- End of line should should be Unix style (`\n`), not Windows style (`\r\n`)
- Opening brackets goes in the same line as the last statement
```
if (condition) {
stuff;
}
```
- A space between keywords and parenthesis for: `if`, `else`, `while`, `switch`, `catch`, `function`
- Function calls have no space before the parentheses
- No spaces are left inside the parentheses
- A space after each comma, but without space before
- All binary operators must have one space before and one after
- There should not be more than one contiguous blank line
- There should be no empty comments
- You should not use block comments `/ * ... * /`, only line `// ...`
- Changes in functionality must be accompanied by their respective new / modified tests
- Exceptions must be used to report erroneous states. The use of functions that return true / false is allowed when they are expected values
- Use [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) when appropriate, mainly in the administration of resources (files, etc ...)

40
en/CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,40 @@
# Contributing Guide
- Contributing to The Documentation Compendium is fairly easy. This document shows you how to get started
## General
- The [Codebase Structure](/CODEBASE_STRUCTURE.md) has detailed information about how the various files in this project are structured
- Please ensure that any changes you make are in accordance with the [Coding Guidelines](/CODING_GUIDELINES.md) of this repo
## Submitting changes
- Fork the repo
- <https://github.com/kylelobo/The-Documentation-Compendium/fork>
- Check out a new branch based and name it to what you intend to do:
- Example:
````
$ git checkout -b BRANCH_NAME
````
If you get an error, you may need to fetch fooBar first by using
````
$ git remote update && git fetch
````
- Use one branch per fix / feature
- Commit your changes
- Please provide a git message that explains what you've done
- Please make sure your commits follow the [conventions](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
- Commit to the forked repository
- Example:
````
$ git commit -am 'Add some fooBar'
````
- Push to the branch
- Example:
````
$ git push origin BRANCH_NAME
````
- Make a pull request
- Make sure you send the PR to the <code>fooBar</code> branch
- Travis CI is watching you!
If you follow these instructions, your PR will land pretty safely in the main repo!

38
en/ISSUE_TEMPLATE/bug_report.md Normal file
View File

@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**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.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

10
en/ISSUE_TEMPLATE/custom.md Normal file
View File

@@ -0,0 +1,10 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''
---

20
en/ISSUE_TEMPLATE/feature_request.md Normal file
View File

@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

12
en/PULL_REQUEST_TEMPLATE.md Normal file
View File

@@ -0,0 +1,12 @@
### Your checklist for this pull request
🚨 Please review the [guidelines for contributing](./CONTRIBUTING.md) to this repository.
- [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your master!
- [ ] Make sure you are making a pull request against the **fooBar branch** (left side).
- [ ] Check the commit's or even all commits' message styles matches our requested structure.
- [ ] Check your code additions will fail neither code linting checks nor unit test.
### Description
Please describe your pull request.
❤️ Thank you!

132
en/README Templates/Bot.md Normal file
View File

@@ -0,0 +1,132 @@
<p align="center">
<a href="" rel="noopener">
<img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
</p>
<h3 align="center">Bot Name</h3>
<div align="center">
[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot)
[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
</div>
---
<p align="center"> 🤖 Few lines describing what your bot does.
<br>
</p>
## 📝 Table of Contents
+ [About](#about)
+ [Demo / Working](#demo)
+ [How it works](#working)
+ [Usage](#usage)
+ [Getting Started](#getting_started)
+ [Deploying your own bot](#deployment)
+ [Built Using](#built_using)
+ [TODO](../TODO.md)
+ [Contributing](../CONTRIBUTING.md)
+ [Authors](#authors)
+ [Acknowledgments](#acknowledgement)
## 🧐 About <a name = "about"></a>
Write about 1-2 paragraphs describing the purpose of your bot.
## 🎥 Demo / Working <a name = "demo"></a>
![Working](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
## 💭 How it works <a name = "working"></a>
The bot first extracts the word from the comment and then fetches word definitions, part of speech, example and source from the Oxford Dictionary API.
If the word does not exist in the Oxford Dictionary, the Oxford API then returns a 404 response upon which the bot then tries to fetch results form the Urban Dictionary API.
The bot uses the Pushshift API to fetch comments, PRAW module to reply to comments and Heroku as a server.
The entire bot is written in Python 3.6
## 🎈 Usage <a name = "usage"></a>
To use the bot, type:
```
!dict word
```
The first part, i.e. "!dict" **is not** case sensitive.
The bot will then give you the Oxford Dictionary (or Urban Dictionary; if the word does not exist in the Oxford Dictionary) definition of the word as a comment reply.
### Example:
> !dict what is love
**Definition:**
Baby, dont hurt me~
Dont hurt me~ no more.
**Example:**
Dude1: Bruh, what is love?
Dude2: Baby, dont hurt me, dont hurt me- no more!
Dude1: dafuq?
**Source:** https://www.urbandictionary.com/define.php?term=what%20is%20love
---
<sup>Beep boop. I am a bot. If there are any issues, contact my [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)</sup>
<sup>Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup>
## 🏁 Getting Started <a name = "getting_started"></a>
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them.
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
End with an example of getting some data out of the system or using it for a little demo.
## 🚀 Deploying your own bot <a name = "deployment"></a>
To see an example project on how to deploy your bot, please see my own configuration:
+ **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
## ⛏️ Built Using <a name = "built_using"></a>
+ [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
+ [Heroku](https://www.heroku.com/) - SaaS hosting platform
## ✍️ Authors <a name = "authors"></a>
+ [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
+ Hat tip to anyone whose code was used
+ Inspiration
+ References

113
en/README Templates/Hackathon.md Normal file
View File

@@ -0,0 +1,113 @@
<p align="center">
<a href="" rel="noopener">
<img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
</p>
<h3 align="center">Project Title</h3>
<div align="center">
[![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com)
[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
</div>
---
<p align="center"> Few lines describing your project.
<br>
</p>
## 📝 Table of Contents
- [Problem Statement](#problem_statement)
- [Idea / Solution](#idea)
- [Dependencies / Limitations](#limitations)
- [Future Scope](#future_scope)
- [Setting up a local environment](#getting_started)
- [Usage](#usage)
- [Technology Stack](#tech_stack)
- [Contributing](../CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgments)
## 🧐 Problem Statement <a name = "problem_statement"></a>
It is useful to design and follow a specific format when writing a problem statement. While there are several options
for doing this, the following is a simple and straightforward template often used in Business Analysis to maintain
focus on defining the problem.
- IDEAL: This section is used to describe the desired or “to be” state of the process or product. At large, this section
should illustrate what the expected environment would look like once the solution is implemented.
- REALITY: This section is used to describe the current or “as is” state of the process or product.
- CONSEQUENCES: This section is used to describe the impacts on the business if the problem is not fixed or improved upon.
This includes costs associated with loss of money, time, productivity, competitive advantage, and so forth.
Following this format will result in a workable document that can be used to understand the problem and elicit
requirements that will lead to a winning solution.
## 💡 Idea / Solution <a name = "idea"></a>
This section is used to describe potential solutions.
Once the ideal, reality, and consequences sections have been
completed, and understood, it becomes easier to provide a solution for solving the problem.
## ⛓️ Dependencies / Limitations <a name = "limitations"></a>
- What are the dependencies of your project?
- Describe each limitation in detailed but concise terms
- Explain why each limitation exists
- Provide the reasons why each limitation could not be overcome using the method(s) chosen to acquire.
- Assess the impact of each limitation in relation to the overall findings and conclusions of your project, and if
appropriate, describe how these limitations could point to the need for further research.
## 🚀 Future Scope <a name = "future_scope"></a>
Write about what you could not develop during the course of the Hackathon; and about what your project can achieve
in the future.
## 🏁 Getting Started <a name = "getting_started"></a>
These instructions will get you a copy of the project up and running on your local machine for development
and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them.
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
## 🎈 Usage <a name="usage"></a>
Add notes about how to use the system.
## ⛏️ Built With <a name = "tech_stack"></a>
- [MongoDB](https://www.mongodb.com/) - Database
- [Express](https://expressjs.com/) - Server Framework
- [VueJs](https://vuejs.org/) - Web Framework
- [NodeJs](https://nodejs.org/en/) - Server Environment
## ✍️ Authors <a name = "authors"></a>
- [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors)
who participated in this project.
## 🎉 Acknowledgments <a name = "acknowledgments"></a>
- Hat tip to anyone whose code was used
- Inspiration
- References

1
en/README Templates/IoT.md Normal file
View File

@@ -0,0 +1 @@
TODO

43
en/README Templates/Minimal.md Normal file
View File

@@ -0,0 +1,43 @@
# Project Title
## Table of Contents
+ [About](#about)
+ [Getting Started](#getting_started)
+ [Usage](#usage)
+ [Contributing](../CONTRIBUTING.md)
## About <a name = "about"></a>
Write about 1-2 paragraphs describing the purpose of your project.
## Getting Started <a name = "getting_started"></a>
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them.
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
End with an example of getting some data out of the system or using it for a little demo.
## Usage <a name = "usage"></a>
Add notes about how to use the system.

9
en/README Templates/README.md Normal file
View File

@@ -0,0 +1,9 @@
### This folder contains various README Templates that one can use based on the type of project.
1. [Bot.md](/README%20Templates/Bot.md) - For if you have an awesome Bot that you want to share with others.
2. [Hackathon.md](/README%20Templates/Hackathon.md) - At a Hackathon and quickly need to set up a beautiful, thorough
README that leaves a lasting impression on the judges? This is the template for you!
3. [IoT.md](/README%20Templates/IoT.md) - This repo nails down the nitty-gritties that go into documenting an IoT project.
4. [Minimal.md](/README%20Templates/Minimal.md) - Quickly set up a very basic, minimal README for your project.
5. [Standard.md](/README%20Templates/Standard.md) - A detailed, comprehensive template that covers all the major aspects
of a README.

101
en/README Templates/Standard.md Normal file
View File

@@ -0,0 +1,101 @@
<p align="center">
<a href="" rel="noopener">
<img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
</p>
<h3 align="center">Project Title</h3>
<div align="center">
[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
</div>
---
<p align="center"> Few lines describing your project.
<br>
</p>
## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](../TODO.md)
- [Contributing](../CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
## 🧐 About <a name = "about"></a>
Write about 1-2 paragraphs describing the purpose of your project.
## 🏁 Getting Started <a name = "getting_started"></a>
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them.
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
End with an example of getting some data out of the system or using it for a little demo.
## 🔧 Running the tests <a name = "tests"></a>
Explain how to run the automated tests for this system.
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
## 🎈 Usage <a name="usage"></a>
Add notes about how to use the system.
## 🚀 Deployment <a name = "deployment"></a>
Add additional notes about how to deploy this on a live system.
## ⛏️ Built Using <a name = "built_using"></a>
- [MongoDB](https://www.mongodb.com/) - Database
- [Express](https://expressjs.com/) - Server Framework
- [VueJs](https://vuejs.org/) - Web Framework
- [NodeJs](https://nodejs.org/en/) - Server Environment
## ✍️ Authors <a name = "authors"></a>
- [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
- Hat tip to anyone whose code was used
- Inspiration
- References

9
en/TODO.md Normal file
View File

@@ -0,0 +1,9 @@
### TODO
---
- [x] Document the README.md file in the [README Templates](/README%20Templates) folder.
- [ ] Make an IoT template (Refer to the various Arduino project documentations for assistance). This template must be detailed and should go in-depth into the various hardware terminologies.
- [ ] Make a minimal IoT template.
- [ ] Add a COMMIT_MESSAGE_GUIDELINES.md file.
- [ ] Translate the various [templates](https://github.com/kylelobo/The-Documentation-Compendium#templates) into different languages - Chinese, Spanish, Portuguese, Russian, etc.