Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added faq section #64

Merged
merged 3 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 13 additions & 51 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"files": [
"README.md"
],
"files": ["README.md"],
"imageSize": 100,
"commit": false,
"contributors": [
Expand All @@ -10,104 +8,70 @@
"name": "DSC NIT Rourkela",
"avatar_url": "https://avatars3.githubusercontent.com/u/51153443?v=4",
"profile": "http://dscnitrourkela.org",
"contributions": [
"projectManagement"
]
"contributions": ["projectManagement"]
},
{
"login": "abhibhaw",
"name": "Abhibhaw Asthana",
"avatar_url": "https://avatars.githubusercontent.com/u/39991296?v=4",
"profile": "https://abhibhaw.co",
"contributions": [
"review",
"maintenance",
"code",
"infra",
"projectManagement"
]
"contributions": ["review", "maintenance", "code", "infra", "projectManagement"]
},
{
"login": "CIPHERTron",
"name": "Pritish Samal",
"avatar_url": "https://avatars.githubusercontent.com/u/56754747?v=4",
"profile": "https://github.com/CIPHERTron",
"contributions": [
"code",
"maintenance",
"mentoring",
"review",
"projectManagement"
]
"contributions": ["code", "maintenance", "mentoring", "review", "projectManagement"]
},
{
"login": "riteshsp2000",
"name": "Ritesh Patil",
"avatar_url": "https://avatars.githubusercontent.com/u/56112399?v=4",
"profile": "http://riteshpatil.dev",
"contributions": [
"code",
"doc",
"ideas",
"projectManagement",
"maintenance"
]
"contributions": ["code", "doc", "ideas", "projectManagement", "maintenance"]
},
{
"login": "DesignrKnight",
"name": "Abel Mathew",
"avatar_url": "https://avatars.githubusercontent.com/u/27865704?v=4",
"profile": "https://github.com/DesignrKnight",
"contributions": [
"code",
"security",
"infra"
]
"contributions": ["code", "security", "infra"]
},
{
"login": "padmajabhol",
"name": "Padmaja Bhol",
"avatar_url": "https://avatars.githubusercontent.com/u/75530516?v=4",
"profile": "https://github.com/padmajabhol",
"contributions": [
"code"
]
"contributions": ["code"]
},
{
"login": "ratnakar5938",
"name": "Ratnakar Sahoo",
"avatar_url": "https://avatars.githubusercontent.com/u/80893583?v=4",
"profile": "https://www.linkedin.com/in/ratnakar-sahoo-a78401135",
"contributions": [
"code"
]
"contributions": ["code"]
},
{
"login": "irsayvid",
"name": "Divya Sri Darimisetti",
"avatar_url": "https://avatars.githubusercontent.com/u/56034618?v=4",
"profile": "https://irsayvid.azurewebsites.net/",
"contributions": [
"code"
]
"contributions": ["code"]
},
{
"login": "sambit-sankalp",
"name": "sambit-sankalp",
"avatar_url": "https://avatars.githubusercontent.com/u/82284130?v=4",
"profile": "https://github.com/sambit-sankalp",
"contributions": [
"code"
]
"contributions": ["code"]
},
{
"login": "Sonakshi1901",
"name": "Sonakshi Satpathy",
"avatar_url": "https://avatars.githubusercontent.com/u/76627480?v=4",
"profile": "https://github.com/Sonakshi1901",
"contributions": [
"code"
]
"contributions": ["code"]
},
{
"login": "nayakastha",
Expand All @@ -129,9 +93,7 @@
"name": "Hemant Bajaj",
"avatar_url": "https://avatars.githubusercontent.com/u/74568847?v=4",
"profile": "https://github.com/ORKO06",
"contributions": [
"code"
]
"contributions": ["code"]
}
],
"contributorsPerLine": 7,
Expand All @@ -140,4 +102,4 @@
"repoType": "github",
"repoHost": "https://github.com",
"skipCi": true
}
}
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: Bug report
description: Create a report to help us improve. Report bugs found while using the project
title: "[BUG] <description>"
title: '[BUG] <description>'
labels: [bug]
body:
- type: markdown
attributes:
value: "Provide a general summary of the issue in the title above"
value: 'Provide a general summary of the issue in the title above'
- type: textarea
id: description
attributes:
Expand Down Expand Up @@ -39,8 +39,8 @@ body:
attributes:
label: Steps to reproduce
description: |
Provide a link to a live example, or an unambiguous set of steps to
reproduce this bug. Include code to reproduce, if relevant
Provide a link to a live example, or an unambiguous set of steps to
reproduce this bug. Include code to reproduce, if relevant
placeholder: |
1.
2.
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Feature request
description: Suggest features, propose improvements, discuss new ideas.
title: "[FEATURE] <description>"
title: '[FEATURE] <description>'
labels: [enhancement]
body:
- type: markdown
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: Other
description: Use this for any other issues. PLEASE do not create blank issues
title: "[OTHER]"
labels: ["awaiting triage"]
title: '[OTHER]'
labels: ['awaiting triage']
body:
- type: markdown
attributes:
value: "# Other issue"
value: '# Other issue'
- type: textarea
id: issuedescription
attributes:
Expand Down
5 changes: 4 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
### Your checklist for this pull request

馃毃Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository.

- [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your default branch!
- [ ] Make sure you are making a pull request against the **default branch** (left side). Also you should start *your branch* off *default branch*.
- [ ] Make sure you are making a pull request against the **default branch** (left side). Also you should start _your branch_ off _default branch_.
- [ ] Check the commit's or even all commits' message styles matches our requested structure.
- [ ] Check your code additions will fail neither code linting checks nor unit test.
- [ ] I have added necessary documentation (if appropriate)

### Description

Please describe your pull request.

鉂わ笍Thank you!

### Post merge checklist

- [ ] Follow steps from the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
- [ ] If you are a new contributor, ping in the thread and one of the maintainers will add you to all-contributors list.
11 changes: 5 additions & 6 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,28 +30,28 @@ jobs:
with:
node-version: 18
cache: 'yarn'
cache-dependency-path: "**/yarn.lock"
cache-dependency-path: '**/yarn.lock'

- name: Use Dev Cache
id: dev-cache
uses: actions/cache@v3
env:
cache-name: cache-dev
with:
# Path for node_modules
path: "**/node_modules"
# Path for node_modules
path: '**/node_modules'
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-build-${{ env.cache-name }}-
${{ runner.os }}-build-
${{ runner.os }}-

- if: ${{steps.dev-cache.outputs.cache-hit != 'true'}}
name: Install Dependencies
run: yarn install

- name: Create production ENV
env:
env:
GATSBY_FIREBASE_API_KEY: ${{ vars.GATSBY_FIREBASE_API_KEY }}
GATSBY_FIREBASE_AUTH_DOMAIN: ${{ vars.GATSBY_FIREBASE_AUTH_DOMAIN }}
GATSBY_FIREBASE_PROJECT_ID: ${{ vars.GATSBY_FIREBASE_PROJECT_ID }}
Expand All @@ -75,4 +75,3 @@ jobs:
- name: Build Check
run: yarn build
continue-on-error: ${{ !inputs.fail-on-error }}

58 changes: 29 additions & 29 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
name: 'CodeQL'

on:
push:
branches: [ main ]
branches: [main]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
branches: [main]
schedule:
- cron: '38 18 * * 4'

Expand All @@ -32,40 +32,40 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
language: ['javascript']
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Checkout repository
uses: actions/checkout@v2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1

# 鈩癸笍 Command-line programs to run using the OS shell.
# 馃摎 https://git.io/JvXDl
# 鈩癸笍 Command-line programs to run using the OS shell.
# 馃摎 https://git.io/JvXDl

# 鉁忥笍 If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
# 鉁忥笍 If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release
#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
12 changes: 6 additions & 6 deletions .github/workflows/development.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
name: Development CI/CD

on:
pull_request:
pull_request:
branches: [main]
types: [opened, synchronize, reopened, edited, ready_for_review]

jobs:
# Currently, not needed as netlify is used for deployment
# build:
# uses: ./.github/workflows/build.yml
# with:
# with:
# fail-on-error: true

prettier:
# needs: build
uses: ./.github/workflows/prettier.yml
with:
with:
fail-on-error: true

eslint:
# needs: build
uses: ./.github/workflows/eslint.yml
with:
with:
fail-on-error: true
7 changes: 3 additions & 4 deletions .github/workflows/eslint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
with:
node-version: 18
cache: 'yarn'
cache-dependency-path: "**/yarn.lock"
cache-dependency-path: '**/yarn.lock'

- name: Use Dev Cache
id: dev-cache
Expand All @@ -31,18 +31,17 @@ jobs:
cache-name: cache-dev
with:
# Path for node_modules
path: "**/node_modules"
path: '**/node_modules'
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-build-${{ env.cache-name }}-
${{ runner.os }}-build-
${{ runner.os }}-

- if: ${{steps.dev-cache.outputs.cache-hit != 'true'}}
name: Install Dependencies
run: yarn install

- name: Eslint Check
run: yarn lint:find
continue-on-error: ${{ github.event.inputs.fail-on-error != 'true'}}

Loading