Merge pull request #383 from thomHayner/gitOps

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at . All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

@@ -1,6 +1,16 @@
 # Issues Reporting Guidelines
 
-Welcome to the LinkedIn Auto Jobs Applier with AI issues page! To keep things organized and ensure issues are resolved quickly, please follow the guidelines below when submitting a bug report, feature request, or any other issue.
+Welcome to the LinkedIn AI Hawk Contributing Guide and Issues Tracker! To keep things organized and ensure issues are resolved quickly, please follow the guidelines below when submitting a bug report, feature request, or any other issue.
+
+If you have a general question, are curious about how something in Python works, please remember that [Google](https://google.com) is your friend and it can answer many questions.
+
+This is a work in progress and you may encounter bugs.
+
+The employers who you are applying to are not looking for candidates who need someone to hold their hand and do everything for them, they are not your parents, they are your potential boses; they will be expecting you to be able to solve simple problems on your own, the AI Hawk mods and devs expect the same of you.
+
+Please do not beg in the issues tracker, discussions or chat.  We are not here to give you a job, we are here to provide you with a tool for you to go out and find a job on your own.  We will try to have instructions for all steps of the process, but you must read the docs, learn on your own, and understand that this is an open-source project run by volunteers.  It will require you to do some work of your own.
+
+If you see something that needs to be documented, or some documentation which could be improved, submit a documentation request or document it yourself and submit a PR to help others understand how that part of the software functions and how to use it.
 
 ## Before You Submit an Issue
 
@@ -12,6 +22,10 @@ Please search through the existing open issues and closed issues to ensure your
 
 Review the README and any available documentation to see if your issue is covered.
 
+Watch this [Intro to AI Hawk video on YouTube](https://www.youtube.com/watch?v=gdW9wogHEUM)
+
+Join us on [Telegram](https://t.me/AIhawkCommunity) to check with the community about issues and ask for help with issues.  If a dev, mod, contributor or other community member is available, a live conversation will likely resolve your small issues and configuration problems faster than using this issues tracker would.
+
 ### 3. Provide Detailed Information
 
 If you are reporting a bug, make sure you include enough details to reproduce the issue. The more information you provide, the faster we can diagnose and fix the problem.
@@ -26,7 +40,7 @@ Please include the following information:
 - **Steps to Reproduce:** Provide detailed steps to reproduce the bug.
 - **Expected Behavior:** What should have happened.
 - **Actual Behavior:** What actually happened.
-- **Environment Details:** Include your OS, browser version (if applicable), and any other relevant environment details.
+- **Environment Details:** Include your OS, browser version (if applicable), which LLM you are using and any other relevant environment details.
 - **Logs/Screenshots:** If applicable, attach screenshots or log outputs.
 
 ### 2. Feature Requests
@@ -39,7 +53,7 @@ For new features or improvements:
 
 ### 3. Questions/Discussions
 
-- If you’re unsure whether something is a bug or if you’re seeking clarification on functionality, you can ask a question. Please make sure to label your issue as a question.
+- If you’re unsure whether something is a bug or if you’re seeking clarification on functionality, you can ask a question. The best place to ask a question is on [Telegram](https://t.me/AIhawkCommunity). If you are asking a question on GitHub, please make sure to label your issue as a question.
 
 ## Issue Labeling and Response Time
 

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: feder-cr

.github/ISSUE_TEMPLATE/bug-issue.yml

@@ -23,10 +23,12 @@ body:
       label: Steps to reproduce
       description: |
         Steps to reproduce the behavior:
-        1. Go to '...'
-        2. Click on '...'
-        3. Scroll down to '...'
-        4. See error
+        1. Use branch named '...'
+        2. Go to file '...'
+        3. Find property named '...'
+        4. Change '...'
+        5. Run program using command '...'
+        6. See error
       placeholder: "List the steps to reproduce the bug..."
 
   - type: input
@@ -44,21 +46,41 @@ body:
       placeholder: "What happened instead?"
 
   - type: dropdown
-    id: environment
+    id: branch
     attributes:
-      label: Environment
-      description: Specify the environment where the bug occurred.
+      label: Branch
+      description: Specify the branch you were using when the bug occurred.
       options:
-        - Production
-        - Development
-        - Staging
+        - main
+        - other
 
   - type: input
-    id: version
+    id: otherBranch
     attributes:
-      label: Version
-      description: Version of the application where the bug occurred.
-      placeholder: "e.g., 1.0.0"
+      label: Branch name
+      description: If you selected ```other``` branch for the previous question, what is the branch name?
+      placeholder: "what-is-the-name-of-the-branch-you-were-using"
+
+  - type: input
+    id: pythonVersion
+    attributes:
+      label: Python version
+      description: Specify the version of Python you were using when the bug occurred.
+      placeholder: "e.g., 3.12.5(64b)"
+
+  - type: input
+    id: llm
+    attributes:
+      label: LLM Used
+      description: Specify the LLM provider you were using when the bug occurred.
+      placeholder: "e.g., ChatGPT"
+
+  - type: input
+    id: model
+    attributes:
+      label: Model used
+      description: Specify the LLM model you were using when the bug occurred.
+      placeholder: "e.g., GPT-4o-mini"
 
   - type: textarea
     id: additional

.gitignore

@@ -115,6 +115,12 @@ ENV/
 env.bak/
 venv.bak/
 
+# GitHub
+.github/
+
+# MacOS
+.DS_Store
+
 # Spyder project settings
 .spyderproject
 .spyproject

README.md

@@ -3,12 +3,13 @@
 <!-- At first glance, the branding and messaging clearly conveys what to expect -->
 <div align="center">
 
-[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/federico-elia-5199951b6/)
-[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:federico.elia.majo@gmail.com)
+  <!-- [![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/AIhawkCommunity) -->
+  [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/federico-elia-5199951b6/)
+  [![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:federico.elia.majo@gmail.com)
 
-# LinkedIn_AIHawk
+  # LinkedIn_AIHawk
 
-#### 🤖🔍 Your AI-powered job search assistant. Automate applications, get personalized recommendations, and land your dream job faster.
+  #### 🤖🔍 Your AI-powered job search assistant. Automate applications, get personalized recommendations, and land your dream job faster.
 
 </div>
 <br />
@@ -31,9 +32,6 @@ Connect with like-minded individuals and get the most out of AIHawk.
 [![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white
 )](https://t.me/AIhawkCommunity)
 
-
-
-
 <!-- 🚀 **Join Our Telegram Community!** 🚀
 
 Join our **Telegram community** for:
@@ -42,7 +40,7 @@ Join our **Telegram community** for:
 - **Job search tips** and **resume advice**
 - **Idea exchange** and resources for your projects
 
-📲 **[Join now!](https://t.me/AIhawkCommunity)** -->
+<-- **[Join now!](https://t.me/AIhawkCommunity)** -->
 
 ![CI](https://github.com/feder-cr/linkedIn_auto_jobs_applier_with_AI/actions/workflows/ci.yml/badge.svg)
 
@@ -53,12 +51,12 @@ Join our **Telegram community** for:
 3. [Installation](#installation)
 4. [Configuration](#configuration)
 5. [Usage](#usage)
-6. [Documentation](#Documentation)
+6. [Documentation](#documentation)
 7. [Troubleshooting](#troubleshooting)
 8. [Conclusion](#conclusion)
 9. [Contributors](#contributors)
 10. [License](#license)
-11. [Disclaimer](#Disclaimer)
+11. [Disclaimer](#disclaimer)
 
 ## Introduction
 
@@ -107,8 +105,20 @@ LinkedIn_AIHawk steps in as a game-changing solution to these challenges. It's n
 
 ## Installation
 
-**Please watch this video to set up your LinkedIn_AIHawk: [How to set up LinkedIn_AIHawk](https://youtu.be/gdW9wogHEUM) - https://youtu.be/gdW9wogHEUM**
-0. **Confirmed succesfull runs OSs & Python**: Python 3.10, 3.11.9(64b), 3.12.5(64b) . Windows 10, Ubuntu 22
+**Please watch this video to set up your LinkedIn_AIHawk: [How to set up LinkedIn_AIHawk- https://youtu.be/gdW9wogHEUM](https://youtu.be/gdW9wogHEUM)**
+
+<!-- It would be helpful to have a YouTube Media Player template that could be combined with this thumbnail... i.e. the 'play button', 'time stamp' and 'progress bar' so that there is a visual que telling users that this is a link to a playable video. -->
+[![How to set up LinkedIn_AIHawk](https://img.youtube.com/vi/gdW9wogHEUM/0.jpg)](https://www.youtube.com/watch?v=gdW9wogHEUM)
+
+**Confirmed succesfull runs on the following:**
+- Operating Systems:
+  - Windows 10
+  - Ubuntu 22
+- Python versions:
+  - 3.10
+  - 3.11.9(64b)
+  - 3.12.5(64b)
+
 1. **Download and Install Python:**
 
    Ensure you have the last Python version  installed. If not, download and install it from Python's official website. For detailed instructions, refer to the tutorials: