Merge pull request #273 from activatedbonkers/v3

Added templates for issues, and guidelines

.github/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# 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.
+
+## Before You Submit an Issue
+
+### 1. Search Existing Issues
+
+Please search through the existing open issues and closed issues to ensure your issue hasn’t already been reported. This helps avoid duplicates and allows us to focus on unresolved problems.
+
+### 2. Check Documentation
+
+Review the README and any available documentation to see if your issue is covered.
+
+### 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.
+
+## Issue Types
+
+### 1. Bug Reports
+
+Please include the following information:
+
+- **Description:** A clear and concise description of the problem.
+- **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.
+- **Logs/Screenshots:** If applicable, attach screenshots or log outputs.
+
+### 2. Feature Requests
+
+For new features or improvements:
+
+- Clearly describe the feature you would like to see.
+- Explain the problem this feature would solve or the benefit it would bring.
+- If possible, provide examples or references to similar features in other tools or platforms.
+
+### 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.
+
+## Issue Labeling and Response Time
+
+We use the following labels to categorize issues:
+
+- **bug:** An issue where something isn't functioning as expected.
+- **documentation:** Improvements or additions to project documentation.
+- **duplicate:** This issue or pull request already exists elsewhere.
+- **enhancement:** A request for a new feature or improvement.
+- **good first issue:** A simple issue suitable for newcomers.
+- **help wanted:** The issue needs extra attention or assistance.
+- **invalid:** The issue is not valid or doesn't seem correct.
+- **question:** Additional information or clarification is needed.
+- **wontfix:** The issue will not be fixed or addressed.
+- We aim to respond to issues as early as possible. Please be patient, as maintainers may have limited availability.
+
+## Contributing Fixes
+
+If you’re able to contribute a fix for an issue:
+
+1. Fork the repository and create a new branch for your fix.
+2. Reference the issue number in your branch and pull request.
+3. Submit a pull request with a detailed description of the changes and how they resolve the issue.

.github/ISSUE_TEMPLATE/bug-issue.yml

@@ -0,0 +1,68 @@
+name: Bug report
+description: Report a bug or an issue that isn't working as expected.
+title: "[BUG]: <Provide a clear, descriptive title>"
+labels: ["bug"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please fill out the following information to help us resolve the issue.
+
+  - type: input
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+      placeholder: "Describe the bug in detail..."
+
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: |
+        Steps to reproduce the behavior:
+        1. Go to '...'
+        2. Click on '...'
+        3. Scroll down to '...'
+        4. See error
+      placeholder: "List the steps to reproduce the bug..."
+
+  - type: input
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What you expected to happen.
+      placeholder: "What was the expected result?"
+
+  - type: input
+    id: actual
+    attributes:
+      label: Actual behavior
+      description: What actually happened instead.
+      placeholder: "What happened instead?"
+
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Environment
+      description: Specify the environment where the bug occurred.
+      options:
+        - Production
+        - Development
+        - Staging
+
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Version of the application where the bug occurred.
+      placeholder: "e.g., 1.0.0"
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+      placeholder: "Any additional information..."

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Questions
+    url: t.me/AIhawkCommunity
+    about: You can join the discussions on Telegram.
+  - name: New issue
+    url: >-
+      https://github.com/feder-cr/linkedIn_auto_jobs_applier_with_AI/blob/v3/.github/CONTRIBUTING.md
+    about: "Before opening a new issue, please make sure to read CONTRIBUTING.md"

.github/ISSUE_TEMPLATE/documentation-issue.yml

@@ -0,0 +1,39 @@
+name: Documentation request
+description: Suggest improvements or additions to the project's documentation.
+title: "[DOCS]: <Provide a short title>"
+labels: ["documentation"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for helping to improve the project's documentation! Please provide the following details to ensure your request is clear.
+
+  - type: input
+    id: doc_section
+    attributes:
+      label: Affected documentation section
+      description: Specify which part of the documentation needs improvement or addition.
+      placeholder: "e.g., Installation Guide, API Reference..."
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Documentation improvement description
+      description: Describe the specific improvements or additions you suggest.
+      placeholder: "Explain what changes you propose and why..."
+
+  - type: input
+    id: reason
+    attributes:
+      label: Why is this change necessary?
+      description: Explain why the documentation needs to be updated or expanded.
+      placeholder: "Describe the issue or gap in the documentation..."
+
+  - type: input
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context, such as related documentation, external resources, or screenshots.
+      placeholder: "Add any other supporting information..."

.github/ISSUE_TEMPLATE/duplicate-issue.yml

@@ -0,0 +1,32 @@
+name: Duplicate issue report
+description: Report an issue or pull request that already exists in the project.
+title: "[DUPLICATE]: <Provide a brief title>"
+labels: ["duplicate"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please provide information about the duplicate issue or pull request.
+
+  - type: input
+    id: duplicate_link
+    attributes:
+      label: Link to the original issue/pull request
+      description: Provide the URL of the original issue or pull request that duplicates this one.
+      placeholder: "https://github.com/your-repo/issue/123"
+
+  - type: input
+    id: reason
+    attributes:
+      label: Reason for marking as duplicate
+      description: Explain why this issue is considered a duplicate.
+      placeholder: "Briefly explain why this is a duplicate."
+
+  - type: input
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any additional context or supporting information.
+      placeholder: "Any additional information or comments..."

.github/ISSUE_TEMPLATE/enhancement-issue.yml

@@ -0,0 +1,46 @@
+name: Feature request
+description: Suggest a new feature or improvement for the project.
+title: "[FEATURE]: <Provide a descriptive title>"
+labels: ["enhancement"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for suggesting a feature! Please fill out the form below to help us understand your idea.
+
+  - type: input
+    id: summary
+    attributes:
+      label: Feature summary
+      description: Provide a short summary of the feature you're requesting.
+      placeholder: "Summarize the feature in a few words..."
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Feature description
+      description: A detailed description of the feature or improvement.
+      placeholder: "Describe the feature in detail..."
+
+  - type: input
+    id: motivation
+    attributes:
+      label: Motivation
+      description: Explain why this feature would be beneficial and how it solves a problem.
+      placeholder: "Why do you need this feature?"
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: List any alternative solutions or features you've considered.
+      placeholder: "Are there any alternative features or solutions you’ve considered?"
+
+  - type: input
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots to support your feature request.
+      placeholder: "Any additional information..."

.github/ISSUE_TEMPLATE/goodfirst-issue.yml

@@ -0,0 +1,46 @@
+name: Good first issue
+description: Suitable for newcomers or those new to the project.
+title: "[GOOD FIRST ISSUE]: <Provide a descriptive title>"
+labels: ["good first issue"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Welcome to contributing to our project! This issue is marked as a "Good First Issue," which means it is a great starting point for new contributors. Please provide the following information to help us understand your issue.
+
+  - type: input
+    id: issue_summary
+    attributes:
+      label: Issue summary
+      description: Provide a brief summary of the issue or task.
+      placeholder: "Summarize the issue or task..."
+
+  - type: textarea
+    id: detailed_description
+    attributes:
+      label: Detailed description
+      description: Provide a detailed description of what needs to be done, including any relevant background information or steps.
+      placeholder: "Describe the issue or task in detail, including any relevant information..."
+
+  - type: input
+    id: steps_to_reproduce
+    attributes:
+      label: Steps to reproduce (if applicable)
+      description: If this issue involves a bug, list the steps to reproduce the problem.
+      placeholder: "List the steps to reproduce the issue (if applicable)..."
+
+  - type: input
+    id: expected_outcome
+    attributes:
+      label: Expected outcome
+      description: Describe what you expect to happen once the issue is resolved.
+      placeholder: "Describe the expected outcome..."
+
+  - type: input
+    id: additional_context
+    attributes:
+      label: Additional context
+      description: Add any other context or information that might be helpful for resolving the issue.
+      placeholder: "Any additional information or comments..."

.github/ISSUE_TEMPLATE/help-issue.yml

@@ -0,0 +1,39 @@
+name: Help wanted
+description: Request additional help or attention for an issue that needs extra effort.
+title: "[HELP WANTED]: <Provide a descriptive title>"
+labels: ["help wanted"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        We need additional help with this issue. Please provide as much detail as possible to assist contributors.
+
+  - type: textarea
+    id: issue_description
+    attributes:
+      label: Issue description
+      description: Provide a detailed description of the issue and what kind of help is needed.
+      placeholder: "Describe the issue and the type of help required..."
+
+  - type: input
+    id: specific_tasks
+    attributes:
+      label: Specific tasks
+      description: List any specific tasks or sub-tasks where help is needed.
+      placeholder: "List specific tasks or areas where help is needed..."
+
+  - type: input
+    id: additional_resources
+    attributes:
+      label: Additional resources
+      description: Provide links to related documentation, resources, or references that might help contributors.
+      placeholder: "Link to relevant resources or documentation..."
+
+  - type: input
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any extra information or context that might help in addressing the issue.
+      placeholder: "Any additional information or comments..."

.github/ISSUE_TEMPLATE/invalid-issue.yml

@@ -0,0 +1,39 @@
+name: Invalid issue report
+description: Report an issue that doesn't seem correct or is invalid.
+title: "[INVALID]: <Provide a brief title>"
+labels: ["invalid"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        If you've identified an issue that seems incorrect or should not exist, please fill out the form below to provide more details.
+
+  - type: input
+    id: reason
+    attributes:
+      label: Reason for invalidation
+      description: Briefly explain why this issue is considered invalid or incorrect.
+      placeholder: "Why do you think this issue is invalid?"
+
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to validate
+      description: Provide steps or evidence that confirm the issue is invalid.
+      placeholder: "Explain how you verified this issue is not valid..."
+
+  - type: input
+    id: original_issue
+    attributes:
+      label: Related issue (if applicable)
+      description: Provide a link to the original issue if this is related to an existing one.
+      placeholder: "Link to the related issue (if applicable)"
+
+  - type: input
+    id: additional
+    attributes:
+      label: Additional context
+      description: Any additional information you think is necessary.
+      placeholder: "Add any other context here..."

.github/ISSUE_TEMPLATE/question-issue.yml

@@ -0,0 +1,39 @@
+name: Question or Information Request
+description: Ask a question or request more information related to the project.
+title: "[QUESTION]: <Provide a short title>"
+labels: ["question"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please fill out the form below to ask your question or request further information.
+
+  - type: input
+    id: question_summary
+    attributes:
+      label: Summary of your question
+      description: Provide a brief summary of your question or information request.
+      placeholder: "Summarize your question in a few words..."
+
+  - type: textarea
+    id: question_details
+    attributes:
+      label: Question details
+      description: Provide a detailed explanation of your question or what information you're requesting.
+      placeholder: "Describe your question or information request in detail..."
+
+  - type: input
+    id: context
+    attributes:
+      label: Context for the question
+      description: Provide any relevant context or background information that may help clarify your question.
+      placeholder: "Add context for your question (e.g., where you encountered the issue, what you're trying to do)..."
+
+  - type: input
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any additional information that may help answer your question.
+      placeholder: "Any extra information or comments..."

.github/ISSUE_TEMPLATE/wontfix-issue.yml

@@ -0,0 +1,32 @@
+name: Won't fix
+description: Mark an issue as won't fix if it will not be addressed or resolved.
+title: "[WONTFIX]: <Provide a brief title>"
+labels: ["wontfix"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This issue will not be fixed. Please provide reasons or context for why the issue is being closed as won't fix.
+
+  - type: textarea
+    id: reason
+    attributes:
+      label: Reason for won't fix
+      description: Explain why this issue will not be fixed or addressed.
+      placeholder: "Describe the reason why this issue is being marked as won't fix..."
+
+  - type: input
+    id: decision_maker
+    attributes:
+      label: Decision maker
+      description: Specify who made the decision to mark the issue as won't fix.
+      placeholder: "Name of the person or team responsible for this decision..."
+
+  - type: input
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context or information relevant to the decision.
+      placeholder: "Any additional information or comments..."