Initial commit

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @caffeine-addictt

.github/CODESTYLE.md

@@ -0,0 +1,82 @@
+# Code Style
+The following is a general guide on how to style your work so that the project
+remains consistent throughout all files. Please read this document in it's entirety
+and refer to it throughout the development of your contribution.
+
+1. [General Guidelines](#general-guidelines)
+2. [Commit Message Guidelines](#commit-message-guidelines)
+3. [Markdown Guidelines](#markdown-guidelines)
+
+
+
+## General Guidelines
+Listed is a example class used demonstrate general rules you should follow throughout the development of your contribution.
+
+- Docstrings are to follow {{DOCSTRING_FORMAT}}
+- Private attributes are to be prefixed with an underscore
+
+```
+code example
+```
+
+
+
+## Commit Message Guidelines
+When committing, commit messages are prefixed with one of the following depending on the type of change made.
+
+ - `feat:` when a new feature is introduced with the changes.
+ - `fix:` when a bug fix has occurred.
+ - `chore:` for changes that do not relate to a fix or feature and do not modify *source* or *tests*. (like updating dependencies)
+ - `refactor:` for refactoring code that neither fixes a bug nor adds a feature.
+ - `docs:` when changes are made to documentation.
+ - `style:` when changes that do not affect the code, but modify formatting.
+ - `test:` when changes to tests are made.
+ - `perf:` for changes that improve performance.
+ - `ci:` for changes that affect CI.
+ - `build:` for changes that affect the build system or external dependencies.
+ - `revert:` when reverting changes.
+
+Commit messages are also to begin with an uppercase character. Below list some example commit messages.
+
+```sh
+git commit -m "docs: Added README.md"
+git commit -m "revert: Removed README.md"
+git commit -m "docs: Moved README.md"
+```
+
+
+## Markdown Guidelines
+Currently, documentation for this project resides in markdown files.
+ - Headings are to be separated with 3 lines
+ - Use of HTML comments is appreciated
+ - Use of HTML is permitted
+ - [reference style links](https://www.markdownguide.org/basic-syntax/#reference-style-links) are not required by are appreciated
+ - Exceedingly long lines are to be broken
+ - The indents are to be 4 spaces
+
+```markdown
+<!--example markdown document-->
+# Section
+Lorem ipsum dolor sit amet, consectetur adipiscing elit,
+sed do eiusmod tempor incididunt ut labore et dolore 
+magna aliqua. Ut enim ad minim veniam, quis nostrud 
+exercitation ullamco laboris nisi ut aliquip ex ea 
+commodo consequat. Duis aute irure dolor in 
+reprehenderit in voluptate velit esse cillum dolore eu 
+fugiat nulla pariatur. Excepteur sint occaecat cupidatat 
+non proident, sunt in culpa qui officia deserunt mollit 
+anim id est laborum. found [Lorem Ipsum Generator]
+
+
+
+# Section 2
+<ul>
+  <li> Apple
+  <li> Orange
+  <li> Pineapple
+</ul>
+
+
+
+[Lorem Ipsum Generator]: https://loremipsum.io/generator/
+```

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# **Contributing**
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+Please note we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions with the project.
+
+
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a
+   build.
+2. Update the README.md with details of changes to the interface; this includes new environment variables, exposed ports, valid file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request once you have the sign-off of two other developers, or if you
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+
+
+## Issue Report Process
+
+1. Go to the project's issues.
+2. Select the template that better fits your issue.
+3. Read the instructions carefully and write within the template guidelines.
+4. Submit it and wait for support.

.github/ISSUE_TEMPLATE/1-bug-report.md

@@ -0,0 +1,80 @@
+---
+name: "Bug Report"
+about: "Report an issue to help the project improve."
+title: "[Bug] "
+labels: "Type: Bug"
+assignees: caffeine-addictt
+
+---
+
+# Bug report
+Your issue may already be reported!
+Please check out our [active issues](https://github.com/{{REPOSITORY}}/issues) before creating one.
+
+
+
+## Expected Behavior
+<!--
+If you're describing a bug, tell us what should happen
+If you're suggesting a change/improvement, tell us how it should work
+
+Please include screenshots and/or code snippets if applicable
+-->
+
+
+
+## Current Behavior
+<!--
+If describing a bug, tell us what happens instead of the expected behavior
+If suggesting a change/improvement, explain the difference from current behavior
+
+Please include screenshots and/or code snippets if applicable
+-->
+
+
+
+## Is this a regression?
+<!--
+Did this behaviour use to work in previous versions?
+If yes, what is the latest version where this behaviour is not present?
+-->
+
+
+
+## Possible Solution
+<!--
+Not obligatory, but suggest a fix/reason for the bug
+or ideas how to implement the addition or change
+-->
+
+
+
+## Steps to Reproduce (for bugs)
+<!--
+Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
+-->
+1.
+2.
+3.
+4.
+
+
+
+## Context
+<!--
+How has this issue affected you?
+What are you trying to accomplish?
+
+Providing context helps us come up with a solution that is most useful in the real world.
+
+Please include screenshots and/or code snippets if applicable
+-->
+
+
+
+## Your Environment
+<!--
+Include as many relevant details about the environment you experienced the bug in
+-->
+* Version used:
+* Operating System and version (desktop or mobile):

.github/ISSUE_TEMPLATE/2-failing-test.md

@@ -0,0 +1,40 @@
+---
+name: "Failing Test"
+about: "Report failing tests or CI jobs."
+title: "[Test] "
+labels: "Type: Test"
+assignees: caffeine-addictt
+
+---
+
+# Failing Test
+Your issue may already be reported!
+Please check out our [active issues](https://github.com/{{REPOSITORY}}/issues) before creating one.
+
+
+
+## Which Jobs/Tests are Failing?
+* 
+
+
+
+## Reason for Failure
+<!--
+Why is/are this/these job/test(s) failing?
+What are we missing to make it pass?
+-->
+
+
+
+## Media Prove
+<!--
+If applicable, add screenshots or code snippets to explain the issue
+If not applicable, remove this field
+-->
+
+
+
+## Additional Context
+<!--
+Any other extra context or information
+-->