Adding best practice documents

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+## 🐛 Describe the bug
+
+<!-- A clear and concise description of what the bug is. -->
+
+## ⚠️ Current 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. -->
+
+## 💣 Steps to reproduce
+
+<!-- How we can reproduce the behavior: -->
+
+## 📷 Screenshots
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+## 📱 Tech info
+
+- Device: <!-- e.g. Chrome, Safari, Docker -->
+- OS: <!-- e.g. Mac, Windows, All -->
+- Library/App version: <!-- e.g. Java8 -->

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+## ⚠️ 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. -->
+
+## 🤚 Do you want to develop this feature yourself?
+
+<!-- Put an `x` symbol into braces of desired choice. -->
+
+- [ ] Yes
+- [ ] No

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+<!-- Thanks for taking the time to write this Pull Request ❤️ -->
+
+## 🚀 Description
+
+<!-- Describe your changes in detail -->
+
+## 📄 Motivation and Context
+
+<!-- Why is this change required? What problem does it solve? -->
+<!-- If it fixes an open issue, please link to the issue here. -->
+
+## 🧪 How Has This Been Tested?
+
+<!-- Please describe in detail how you tested your changes. -->
+<!-- Include details of your testing environment, tests ran to see how -->
+<!-- your change affects other areas of the code, etc. -->
+
+## 📷 Screenshots (if appropriate)
+
+<!-- Please provide a screenshot of your change -->
+
+## 📦 Types of changes
+
+<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## ✅ Checklist
+
+<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] My code follows the code style of this project(Do your best to follow code styles. If none apply just skip this).
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.

.github/workflows/first-pr-greeting.yml

@@ -0,0 +1,15 @@
+name: "First PR greeter"
+on: [pull_request]
+
+jobs:
+  pr-greeter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Greet first PR
+        uses: actions/first-interaction@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          pr-message: |
+            ## Hurray!
+            Looks like this is your first PR👏
+            Thanks for contributing and welcome to the community 🎉

.github/workflows/gradle-wrapper-validation.yml

@@ -0,0 +1,18 @@
+name: Validate Gradle Wrapper
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  validation:
+    name: Validation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout latest code
+        uses: actions/checkout@v2
+      - name: Validate Gradle Wrapper
+        uses: gradle/wrapper-validation-action@v1

.github/workflows/gradle.yml

@@ -5,13 +5,12 @@ name: Java CI with Gradle
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing
+
+Firstly, thanks for taking time to contribute to this reporitory! People like you power this open source community.
+
+Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## How to file a bug report or feature request?
+
+1. This repository has issue, feature request and pull request templates which would autofill when you raise a bug, request for a new feature or when you raise a PR. Do your best to fill out the template completely.
+
+## 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, useful 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. Pull requests will be approved by one of the owners of this repository.
+
+## How to set up your environment and run tests?
+
+1. Building and installation instructions are present in README.md file.

README.md

@@ -1,6 +1,6 @@
 # MyHome Application
 
-A Java application which helps people to manage their apartment.
+MyHome helps people to manage their apartment.
 
 Join us at Discord [here](https://discord.gg/CngACKh).
 
@@ -9,13 +9,15 @@ Join us at Discord [here](https://discord.gg/CngACKh).
 [![Discord](https://img.shields.io/discord/731769161361129523?label=discord)](https://discord.gg/CngACKh)
 [![Good First Issue](https://img.shields.io/github/issues-raw/jmprathab/MyHome/good%20first%20issue?label=beginner%20friendly%20issues)](https://github.com/jmprathab/MyHome/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3Aup-for-grabs)
 
-## Prerequisites
+## Installing
+
+### Prerequisites
 
 * Gradle
 * Java 8 (JDK)
 * Docker for running service inside container (You can also run it without docker)
 
-## Installing
+### Building
 
 1. Download the Project to local drive
 2. Run `gradlew assemble`
@@ -38,17 +40,16 @@ http://localhost:8080/docs/swagger-ui.html hosts Swagger UI.
 * [Gangadhar](https://github.com/gangadhargo)
 * [mar731](https://github.com/mar731)
 
-## License
-
-This project is licensed under the Apache License - see the [LICENSE.md](LICENSE.md) file for details
-
-## Contribution
+## How do I contribute?
 
 Feel free to contribute to the project. Please make sure to follow the below list before contributing.
 
-* Read `CODE_OF_CONDUCT.md`
+* Read `CONTRIBUTING.md`
 * This project uses coding style from https://github.com/square/java-code-styles
-* Make sure all test cases pass before requesting for a PR.
+
+## License
+
+This project is licensed under the Apache License - see the [LICENSE.md](LICENSE.md) file for details
 
 ## Acknowledgments