Initial commit

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,15 @@
+---
+name: Bug Report
+about: Report something that is broken or not working as intended
+title: ''
+labels: ''
+assignees: ''
+---
+
+#### Expected Behaviour
+
+#### Actual Behaviour
+
+#### Steps to Reproduce
+-
+

.github/ISSUE_TEMPLATE/code-maintenance.md

@@ -0,0 +1,14 @@
+---
+name: Code Maintenance
+about: Project cleanup, improve documentation, refactor code
+title: ''
+labels: ''
+assignees: ''
+---
+
+#### Describe Problem
+
+#### Suggest Changes
+
+#### Provide Examples
+

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,14 @@
+---
+name: Feature Request
+about: Suggest an idea for a new feature or enhancement to existing features
+title: ''
+labels: ''
+assignees: ''
+---
+
+#### Describe Problem
+
+#### Suggest Solution
+
+#### Additional Details
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Did you read the rules to contributing in `CONTRIBUTING.md`
+
+### What are you trying to accomplish?
+
+
+### How are you accomplishing it?
+
+
+### Is there anything reviewers should know?
+
+
+### If needed, did you change documentation(`README.md`, `ARCHITECTURE.md`, etc) to reflect your changes?
+
+- [x] Is it safe to rollback this change if anything goes wrong?

ARCHITECTURE.md

@@ -0,0 +1,22 @@
+# Architecture
+**This document describes the high-level architecture of this project**
+
+If you want to familiarize yourself with the code base and *generally* how it works, this is a good place to be.
+
+## High Level TLDR
+<DESCRIPTION>
+
+## Code Map
+
+#### Code Map Legend
+
+`<file name>` for a file name
+
+`<folder name>/` for a folder
+
+`<folder name>/<file name>` for a file within a folder
+
+### `<EXAMPLE>`
+
+example description
+

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+
+## Fork and Pull Request Proccess
+
+Create a fork of the project
+
+Make your changes
+
+Create a pull request
+
+when creating a pull request, please make sure that 
+* You follow this projects naming conventions
+* You follow this projects structure
+* You remove all debugging helpers(byebug, puts, etc)
+* You comment your code to explain how it works
+* You add to the documentation if needed
+* Your code works
+* You make your code easily readable and modifiable
+
+## Code of Conduct
+
+We want to foster an open and welcoming environment. We will answer any questions and issues. As this is a harassment-free environment, not being open to people of any kind will result in a ban.
+
+## Starting an Issue
+
+Need help or want to bring something to our attention? Create an issue. There are multiple kinds but the 3 kinds that we support are bug report, code maintenance, and feature request. 
+
+### Labels
+
+We use labels to denote what is going on an issue. You can search by issues or use them as a quick guide to an issue.
+
+some important labels are 
+* `bug` when something isn't working
+* `dependencies` to update the dependencies
+* `enhancement` for adding a new feature or functionality
+* `help wanted` for asking for help 
+* `question` for asking a question
+* `security` for an issue with security
+

README.md

@@ -0,0 +1,13 @@
+# PROJECT NAME
+
+**WARNING: these instructions work best on a unix based system**
+
+## Setup
+
+setup example text
+
+## Contributing
+You can read all about contributing to this project in `CONTRIBUTING.md`
+
+## Architecture
+You can read about it in `ARCHITECTURE.md`

license

@@ -0,0 +1,8 @@
+Copyright © 2021 <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+