Merge from the develop branch (#6)

* Added markdown files

* Updated markdown (#5)

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing to our Project
+Thank you for your interest in contributing to our project. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated.
+
+If you are new to contributing to open source, please read the Open Source Guides on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).
+
+## Ways to Contribute
+We know you are ready to start contributing code right away! Hers is a list of [good first issues](https://github.com/PalisadoesFoundation/switchmap-ng-docs/labels/good%20first%20issue) that contain issues with a limited scope.
+
+## Quicklinks
+
+- [Contributing to our Project](#contributing-to-our-project)
+  - [Ways to Contribute](#ways-to-contribute)
+  - [Quicklinks](#quicklinks)
+    - [Our Development Process](#our-development-process)
+      - [Issues](#issues)
+      - [Pull Requests](#pull-requests)
+      - [Git Flow](#git-flow)
+    - [Contributing Code](#contributing-code)
+    - [Internships](#internships)
+  - [Community](#community)
+
+
+
+### Our Development Process
+We utilize GitHub issues and pull requests to keep track of issues and contributions from the community.
+
+#### Issues
+Make sure you are following [issue report guidelines](ISSUE_GUIDELINES.md) available here before creating any new issues to the project.
+
+#### Pull Requests
+[Pull Request guidelines](PR_GUIDELINES.md) is best resource to follow to start working on open issues.
+
+#### Git Flow
+For this project, we utilize the GitFlow branching model. GitFlow is geared towards efficiently tracking development and managing releases. The model makes parallel development efforts easy and safe by isolating new development efforts from completed work.
+
+The different types of branches we may use are:
+* Feature branches (feature/branch-name)
+* Release branches (release/1.XX)
+* Bug branches  (bugfix/branch-name)
+* Hotfix branches (hotfix/branch-name)
+
+Detailed document containing how GitFlow works: https://nvie.com/posts/a-successful-git-branching-model/
+
+### Contributing Code
+Code contributions to this project come in the form of pull requests. These are done by forking the repo and making changes locally.
+
+Make sure you have read the [Documentation for Setting up the Project](https://github.com/PalisadoesFoundation/switchmap-ng-docs#readme)
+
+The process of proposing a change to this project can be summarized as:
+1. Fork the project repository and branch off `master`.
+2. The repository can be cloned locally using `git clone <forked repo url>`.
+3. Make the desired changes to the project source code.
+4. Run the website and test your changes.
+5. If you've added code that should be tested, write tests.
+6. After making changes you can add them to git locally using `git add <file_name>`(to add changes only in a particular file) or `git add .` (to add all changes).
+7. After adding the changes you need to commit them using `git commit -m '<commit message>'`(look at the commit guidelines below for commit messages).
+8. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.)
+9. Now create a pull request to the project repository from your forked repo. Open an issue regarding the same and link your PR to it.
+10. Ensure the test suite passes, either locally or on CI once a PR has been created.
+11. Review and address comments on your pull request if requested.
+
+### Internships
+If you are participating in any of the various internship programs we ar members of then please read the [internship introduction guides](https://developer.palisadoes.org/docs/category/internships).
+
+## Community
+There are many ways to communicate with the community.
+
+1. The Palisadoes Foundation has a Slack channel where members can assist with support and clarification. Visit the [Palisadoes Foundation's GitHub repository home page](https://github.com/PalisadoesFoundation) for the link to join our slack channel.
+2. We also have a technical email list run by [freelists.org](https://www.freelists.org/). Search for "palisadoes" and join. Members on this list are also periodically added to our marketing email list that focuses on less technical aspects of our work.

ISSUE_GUIDELINES.md

@@ -0,0 +1,59 @@
+# Issue Report Guidelines
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+In order to give everyone a chance to submit a issues reports and contribute to our projects, we have put restrictions in place. This section outlines the guidelines that should be imposed upon issue reports in our projects.
+
+___
+## Table of Contents
+<!-- TOC -->
+
+- [Issue Report Guidelines](#issue-report-guidelines)
+  - [Table of Contents](#table-of-contents)
+  - [Issue Management](#issue-management)
+    - [New Issues](#new-issues)
+    - [Existing Issues](#existing-issues)
+    - [Feature Request Issues](#feature-request-issues)
+    - [Monitoring the Creation of New Issues](#monitoring-the-creation-of-new-issues)
+  - [General Guidelines](#general-guidelines)
+
+<!-- /TOC -->
+___
+## Issue Management
+
+In all cases please use the [GitHub open issue search](https://github.com/PalisadoesFoundation/switchmap-ng-docs/issues) to check whether the issue has already been reported.
+
+### New Issues
+To create new issues follow these steps:
+
+1. Your issue may have already been created. Search for duplicate open issues before submitting yours.for similar deficiencies in the code.duplicate issues are created. 
+1. Verify whether the issue has been fixed by trying to reproduce it using the latest master or development branch in the repository.
+1. Click on the [`New Issue`](https://github.com/PalisadoesFoundation/switchmap-ng-docs/issues/new/choose) button
+1. Use the templates to create a standardized report of what needs to be done and why.
+1. If you want to be assigned the issue that you have created, then add a comment immediately after submitting it.
+
+We welcome contributors who find new ways to make the code better.
+
+### Existing Issues
+
+You can also be a valuable contributor by searching for dormant issues. Here's how you can do that:
+
+1. **Previously Assigned Issues**: We regularly review issues and add a [`no-issue-activity`](https://github.com/PalisadoesFoundation/switchmap-ng-docs/issues?q=is%3Aissue+is%3Aopen+label%3Ano-issue-activity) label to them. Use the issue comments to ask whether the assignee is still working on the issue, and if not, ask for the issue to be assigned to you.
+1. **Unassigned Issues**: If the issue is already reported and [not assigned to anyone](https://github.com/PalisadoesFoundation/switchmap-ng-docs/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee) and you are interested in working on the issue then:
+   1. Ask for the issue to be assigned to you in the issue comments
+   2. Ask our contributors to assign it to you in our slack channel.
+
+Working on these types of existing issues is a good way of getting started with the community.
+
+### Feature Request Issues
+
+Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the mentors of the merits of this feature. Please provide as much detail and context as possible.
+
+### Monitoring the Creation of New Issues 
+1. Join our slack channel for automatic issue and pull request updates
+
+## General Guidelines
+
+1. Discuss issues in our various slack channels when necessary
+2. Please do not derail or troll issues. 
+3. Keep the discussion on topic and respect the opinions of others.

PR_GUIDELINES.md

@@ -0,0 +1,31 @@
+# Pull Request Guidelines
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+In order to give everyone a chance to submit a pull request and contribute to the project, we have put restrictions in place. This section outlines the guidelines that should be imposed upon pull requests in the project.
+
+## Pull Requests and Issues
+1. Do not start working on any open issue and raise a PR unless the issue is assigned to you. PRs that don't meet these guidelines will be closed.
+1. Pull requests must be based on [open issues](https://github.com/PalisadoesFoundation/switchmap-ng-docs/issues) available.
+1. [Use this method to automatically close the issue when the PR is completed.](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)
+
+## Testing
+1. All pull requests must have test units. If, for some reason, it is not possible to add tests, please let us know and explain why. In that case, you'll need to tell us what steps you followed to manually test your changes.
+1. Please read our [CONTRIBUTING.md](CONTRIBUTING.md) document for details on our testing policy.
+
+## Pull Request Processing
+1. We do not accept draft Pull Requests. They will be closed if submitted. We focus on work that is ready for immediate review.
+1. Removing assigned reviewers from your Pull Request will cause it to be closed. The quality of our code is very important to us. Therefore we make experienced maintainers of our code base review your code. Removing these assigned persons is not in the best interest of this goal.
+1. If you have not done so already, please read the `Pull Requests and Issues` and `Testing` sections above.
+1. Each contributor may only create one pull request at a time. We have this rule in place due to our limited resources - if everyone was allowed to post multiple pull requests, we would not be able to review them properly. It is also better for contributors because you can focus on creating one quality PR - so spend time making sure it is as good as it can be.
+1. Upon successful push to the fork, check if all tests are passing; if not, fix the issues and then create a pull request.
+1. If the pull request's code quality is not up to par, or it would break the app, it will more likely be closed. So please be careful when creating a PR.
+1. Please follow the PR template provided. Ensure the PR title clearly describes the problem it is solving. In the description, include the relevant issue number, snapshots, and videos after changes are added.
+1. If you are borrowing a code, please disclose it. It is fine and sometimes even recommended to borrow code, but we need to know about it to assess your work. If we find out that your pull request contains a lot of code copied from elsewhere, we will close the pull request.
+1. No Work In Progress. ONLY completed and working pull requests and with respective test units will be accepted. A WIP would fall under rule 4 and be closed immediately.
+1. Please do not @mention contributors and mentors. Sometimes it takes time before we can review your pull request or answer your questions, but we'll get to it sooner or later. @mentioning someone just adds to the pile of notifications we get and it won't make us look at your issue faster.
+1. Do not force push. If you make changes to your pull request, please simply add a new commit, as that makes it easy for us to review your new changes. If you force push, we'll have to review everything from the beginning.
+1. PR should be small, easy to review and should follow standard coding styles.
+1. If PR has conflicts because of recently added changes to the same file, resolve issues, test new changes, and submit PR again for review.
+1. PRs should be atomic. That is, they should address one item (issue or feature)
+1. After submitting PR, if you are not replying within 48 hours, then in that case, we may need to assign the issue to other contributors based on the priority of the issue.

README.md

@@ -1,2 +1,28 @@
-# switchmap-ng-api
+# Switchmap-NG API Documentation
+
+💬 Join the community on Slack from our [Palisadoes Foundation GitHub Home Page](https://github.com/PalisadoesFoundation)
+
+[![N|Solid](static/img/markdown/misc/logo.png)](https://github.com/PalisadoesFoundation/switchmap-ng-api)
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/switchmap-ng-api.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/switchmap-ng-api)
+[![GitHub forks](https://img.shields.io/github/forks/PalisadoesFoundation/switchmap-ng-api.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/PalisadoesFoundation/switchmap-ng-api)
+
+## About Palisadoes
+
+The [Palisadoes Foundation’s](https://www.palisadoes.org) open-source software projects started in 2016 when a group of expatriate Jamaicans wanted to assist development of new and existing information technologies for the island’s social good. 
+
+Over the years the scope of our work has expanded. Our volunteers now live in all timezones of the globe and work on projects with a truly international scope.
+
+- [Our Website](https://www.palisadoes.org)<br>
+- [Our Developer Website](https://developer.palisadoes.org)
+
+## About This Repository
+
+This repo hosts the documentation you see on the https://developer.palisadoes.org site.
+
+## Documentation
+
+- Want to contribute? Look at [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
+