chore: add prettier linter and github action (anitab-org#297)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,35 +1,42 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-
-### 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.
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+### 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.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +1,20 @@
----
-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.
-
-### 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.
+---
+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.
+
+### 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.

.github/ISSUE_TEMPLATE/user-story.md

@@ -1,26 +1,33 @@
----
-name: User story
-about: Create your development plans and work tasks here.
-
----
-
-## Description
-As a [USER],
-I need [TO DO THIS],
-so that I can [ACCOMPLISH THAT].
-
-## Mocks
-[INSERT RELEVANT PNG FILE]
-
-## Acceptance Criteria
-### Update [Required]
-- [ ] [LIST ITEMS]
-### Enhancement to Update [Optional]
-- [ ] [LIST ITEMS]
-
-## Definition of Done
-- [ ] All of the required items are completed.
-- [ ] Approval by 1 mentor.
-
-## Estimation
-[INSERT NUMBER HERE] hours
+---
+name: User story
+about: Create your development plans and work tasks here.
+---
+
+## Description
+
+As a [USER],
+I need [TO DO THIS],
+so that I can [ACCOMPLISH THAT].
+
+## Mocks
+
+[INSERT RELEVANT PNG FILE]
+
+## Acceptance Criteria
+
+### Update [Required]
+
+- [ ] [LIST ITEMS]
+
+### Enhancement to Update [Optional]
+
+- [ ] [LIST ITEMS]
+
+## Definition of Done
+
+- [ ] All of the required items are completed.
+- [ ] Approval by 1 mentor.
+
+## Estimation
+
+[INSERT NUMBER HERE] hours

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,6 +5,7 @@ Include a summary of the change and relevant motivation/context. List any depend
 Fixes # [ISSUE]
 
 ### Type of Change:
+
 **Delete irrelevant options.**
 
 - Code
@@ -14,18 +15,18 @@ Fixes # [ISSUE]
 - Documentation
 
 **Code/Quality Assurance Only**
+
 - Bug fix (non-breaking change which fixes an issue)
 - This change requires a documentation update (software upgrade on readme file)
 - New feature (non-breaking change which adds functionality pre-approved by mentors)
 
-
-
 ### How Has This Been Tested?
+
 If you are working on a design then add a gif to show the responsiveness of your design.
 Please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR) and share the link of deployed site here.
 
-
 ### Checklist:
+
 **Delete irrelevant options.**
 
 - [ ] My PR follows the style guidelines of this project
@@ -35,8 +36,8 @@ Please follow [testing guidelines](https://github.com/anitab-org/anitab-org.gith
 - [ ] I have attached link of deployed site.
 - [ ] Any dependent changes have been merged
 
-
 **Code/Quality Assurance Only**
+
 - [ ] My changes generate no new warnings
 - [ ] My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected)
 - [ ] I have added tests that prove my fix is effective or that my feature works

.github/config.yml

@@ -36,4 +36,4 @@ welcomeMessage: >
   You may submit a PR on the same if you like!
   If you want to report a bug 🐞 & please follow our [Bug_Report.md](https://github.com/anitab-org/anitab-org.github.io/blob/develop/docs/.github/ISSUE_TEMPLATE/bug_report.md/) template. Also please make sure you include steps to reproduce it and be patient we will get back to you as soon as we can.👀
   Also feel free to join us on [AnitaB.org Open Source Zulip Community](https://anitab-org.zulipchat.com/login/)🤝. We have different streams for each active repo's for discussions.
-  Hope you have a great time here :)
+  Hope you have a great time here :)

.github/workflows/deploy.yml

@@ -1,26 +1,37 @@
 # This is a basic workflow to help you get started with Actions
 
 name: Build and Deploy to GitHub static pages
-# Controls when the action will run. 
+# Controls when the action will run.
 on:
-  # Triggers the workflow on push or pull request events but only for the develop branch
+  # Triggers the workflow on push or pull request events but only for pushes on the develop branch
+  pull_request:
   push:
-    branches: [ develop ]
+    branches: [develop]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
+  # This workflow formats the code with our linter (Prettier) and then builds
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Prettify code
+        uses: creyD/[email protected]
   build:
     # The type of runner that the job will run on
+    if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      
+
       - name: Checkout 🛎️
         uses: actions/[email protected] # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
         with:

.prettierignore

@@ -0,0 +1,21 @@
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

README.md

@@ -1,4 +1,3 @@
-
 [![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://anitab-org.zulipchat.com/#narrow/stream/235478-anitab-org.2Egithub.2Eio)
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
 ![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)
@@ -7,8 +6,6 @@
 [![GitHub forks](https://img.shields.io/github/forks/Naereen/StrapDown.js.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/anitab-org/anitab-org.github.io/network/members)
 [![GitHub stars](https://img.shields.io/github/stars/Naereen/StrapDown.js.svg?style=social&label=Star&maxAge=2592000)](https://github.com/anitab-org/anitab-org.github.io/stargazers)
 
-
-
 # anitab-org.github.io
 
 This is the main website for **AnitaB.org Open Source**. It contains information about our various open source projects, the programs we participate in, information about how to contribute, and how to contact us.This website acts as an interface to help introduce people to the organization's Open Source community, and make the transition from newcomers to contributors easier.
@@ -19,31 +16,31 @@ To setup the project locally follow the instructions:
 
 #### Fork
 
-_**Note**_: *This is only needed if you want to contribute to the project.*
+_**Note**_: _This is only needed if you want to contribute to the project._
 
 If you want to contribute to the project you will have to create your own copy of the project on GitHub. You can do this by clicking the Fork button that can be found on the top right corner of the [landing page](https://github.com/anitab-org/anitab-org.github.io) of the repository.
 
 #### Clone
 
-_**Note**_: *For this you need to install git on your machine. You can download the git tool from [here](https://git-scm.com/downloads).*
+_**Note**_: _For this you need to install git on your machine. You can download the git tool from [here](https://git-scm.com/downloads)._
+
+- If you have forked the project, run the following command -
 
- * If you have forked the project, run the following command -
-
-   `git clone https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io`
+  `git clone https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io`
 
-   where `YOUR_GITHUB_USER_NAME` is your GitHub handle.
+  where `YOUR_GITHUB_USER_NAME` is your GitHub handle.
 
- * If you haven't forked the project, run the following command -
+- If you haven't forked the project, run the following command -
 
-   `git clone https://github.com/anitab-org/anitab-org.github.io`
-
- * Now after you cloned the repository, get into the anitab-org.github.io directory by -
+  `git clone https://github.com/anitab-org/anitab-org.github.io`
 
-   `cd anitab-org.github.io`
+- Now after you cloned the repository, get into the anitab-org.github.io directory by -
+
+  `cd anitab-org.github.io`
 
 #### Remote
 
-_**Note**_: *This is only needed if you want to contribute to the project.*
+_**Note**_: _This is only needed if you want to contribute to the project._
 
 When a repository is cloned, it has a default remote named `origin` that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named upstream. For this project it can be done by running the following command -
 
@@ -59,24 +56,21 @@ upstream        https://github.com/anitab-org/anitab-org.github.io.git (fetch)
 upstream        https://github.com/anitab-org/anitab-org.github.io.git (push)
 ```
 
-
 ### Run app
 
 Download the latest stable version of NodeJs [here](https://nodejs.org/en/download/) and install it. Install `yarn`. Run `node --version` and `yarn --version` to verify successful installation.
 
 To get the frontend running locally:
 
- * Clone this repository
- * `yarn` to install all required dependencies
- * `yarn start` to start the local server
-
-
- ## Prerequisites
-
- **Javascript** - We are using technologies such as javascript , HTML , CSS for our website AnitaB.org Open Source.
-
- **ReactJS** - As our Whole content is written in ReactJS so we can easly transform this into native apps in future.
+- Clone this repository
+- `yarn` to install all required dependencies
+- `yarn start` to start the local server
+
+## Prerequisites
+
+**Javascript** - We are using technologies such as javascript , HTML , CSS for our website AnitaB.org Open Source.
 
+**ReactJS** - As our Whole content is written in ReactJS so we can easly transform this into native apps in future.
 
 ## Contributing