Merge branch 'main' of https://github.com/arunp77/Job-Market-project

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: GitHub Community Support
+    url: https://github.com/orgs/community/discussions
+    about: Please ask and answer questions here.
+  - name: GitHub Security Bug Bounty
+    url: https://bounty.github.com/
+    about: Please report security vulnerabilities here.

README.md

@@ -72,16 +72,17 @@ The project is divided into the following stages and sub-stages
 ```
 Job-Market-Data-Engineering-Project/
 │
+├── .env                                      # to save the APIs secret keys and are ignored before pushing the files to GitHub via .gitignore
 ├── .github/
-│   └── workflows/
-│       └── ci.yml           # GitHub Actions workflow file
+│   └── workflows/                            # Contains all the ci-cd yml and the Issue/bug files 
+│       └── ci.yml                            # GitHub Actions workflow file
 │
 ├── scripts/
 │   ├── web_scraping/
-│   │   ├── scraping_script.py
-│   │   └── requirements.txt
+│   │   ├── scraping_script.py                # This could be `.ipynb` file
+│   │   └── requirements.txt                  # Depednent files
 │   └── etl/
-│       └── etl_script.py
+│       └── etl_script.py                     # The etl python file
 │
 ├── data/
 │   ├── scraped_data/

SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.