Skip to content

Commit

Permalink
Initial commit without history
Browse files Browse the repository at this point in the history
  • Loading branch information
feder-cr committed Sep 25, 2024
0 parents commit 675d8da
Show file tree
Hide file tree
Showing 46 changed files with 5,816 additions and 0 deletions.
73 changes: 73 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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
79 changes: 79 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Issues Reporting Guidelines

Welcome to the 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

### 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.

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.

## 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), which LLM you are using 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. 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

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.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: feder-cr
90 changes: 90 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
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. 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
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: branch
attributes:
label: Branch
description: Specify the branch you were using when the bug occurred.
options:
- main
- other

- type: input
id: otherBranch
attributes:
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
attributes:
label: Additional context
description: Add any other context about the problem here.
placeholder: "Any additional information..."
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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/Auto_Jobs_Applier_AIHawk/blob/v3/.github/CONTRIBUTING.md
about: "Before opening a new issue, please make sure to read CONTRIBUTING.md"
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-issue.yml
Original file line number Diff line number Diff line change
@@ -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..."
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/duplicate-issue.yml
Original file line number Diff line number Diff line change
@@ -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..."
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement-issue.yml
Original file line number Diff line number Diff line change
@@ -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..."
Loading

0 comments on commit 675d8da

Please sign in to comment.