Skip to content

Commit

Permalink
Merge branch 'release/v4.1.0' into firefox-patch
Browse files Browse the repository at this point in the history
  • Loading branch information
surapuramakhil authored Dec 2, 2024
2 parents c160ece + cc0b814 commit 84e3cea
Show file tree
Hide file tree
Showing 14 changed files with 1,282 additions and 90 deletions.
40 changes: 40 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
- **Title**: [Descriptive title of the changes]
- **Description**: [Provide a clear description of the changes and their purpose]
- **Related Issues**: #[issue number]
- **Type**:
- [ ] Feature
- [ ] Bug Fix
- [ ] Refactor
- [ ] Documentation
- [ ] Other:

## Implementation Details

- [ ] Changes are focused and solve the stated problem
- [ ] Code follows project style guides
- [ ] Complex logic is documented
- [ ] No unnecessary complexity introduced

## Testing

- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing completed
- [ ] All tests passing

## Documentation & Quality

- [ ] Project documentation updated
- [ ] Code reviewed for clarity
- [ ] Breaking changes clearly marked
- [ ] Dependencies documented

## Deployment Impact

- [ ] Database migrations required? [Yes/No]
- [ ] Configuration changes needed? [Yes/No]
- [ ] Breaking changes? [Yes/No]

## Additional Notes

[Add any other context or notes for reviewers]
681 changes: 649 additions & 32 deletions LICENSE

Large diffs are not rendered by default.

24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Join our community: [Telegram](https://t.me/AIhawkCommunity) (for Normal user) |

</div>

**Creator** [feder-cr](https://github.com/feder-cr), Co-Founder of Ai Hawk </br>
As AI Hawk is focusing on their proprietary product - solving problems in hiring for companies, currently this project is led, managed, and maintained by a group of open-source contributors, with a focus on building tools to help job seekers land the jobs they deserve.
**Creator** [feder-cr](https://github.com/feder-cr), Co-Founder of AIHawk </br>
As AIHawk is focusing on their proprietary product - solving problems in hiring for companies, currently this project is led, managed, and maintained by a group of open-source contributors, with a focus on building tools to help job seekers land the jobs they deserve.

**Project Maintainers / Leads**: [surapuramakhil](https://github.com/surapuramakhil), [sarob](https://github.com/sarob), [cjbbb](https://github.com/cjbbb)

Expand Down Expand Up @@ -227,6 +227,17 @@ This file defines your job search parameters and bot behavior. Each section cont
- Data Scientist
```
- `keywords_whitelist:`
- List keywords to look for in the job description, for example, "chromium browser". This field is optional.
- Only use this field to find jobs that require specific technologies, products, or skills that is not mentioned in the job title.
- Warning: Any jobs without matching keywords in the job description will be skipped.
- Example:

```yaml
keywords_whitelist:
- chromium browser
```

- `locations:`
- List locations you want to search in, one per line
- Example:
Expand Down Expand Up @@ -730,7 +741,7 @@ For further assistance, please create an issue on the [GitHub repository](https:

### For Developers

- [Contribution Guidelines](CONTRIBUTING.md)
- [Contribution Guidelines](docs/CONTRIBUTING.md)

- [Lang Chain Developer Documentation](https://python.langchain.com/v0.2/docs/integrations/components/)

Expand Down Expand Up @@ -763,7 +774,12 @@ Made with [contrib.rocks](https://contrib.rocks).

## License

This project is licensed under the MIT + Commons Clause License - see the [LICENSE](LICENSE) file for details.
This project is licensed under the AGPL License. Documentation is licensed under CC BY - see the [AGPL LICENSE](LICENSE) and [CC BY LICENSE](docs/LICENSE) files for details.

The AGPL License requires that any derivative work must also be open source and distributed under the same license.

The CC BY License permits others to distribute, remix, adapt, and build upon your work, even for commercial purposes, as long as they credit you for the original creation.


## Disclaimer

Expand Down
5 changes: 5 additions & 0 deletions data_folder/work_preferences.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ date:
positions:
- Software engineer

# One or more keywords to look for in the job description, for example, "chromium browser". This field is optional.
# Only use this field to find jobs that require specific technologies, products, or skills that is not mentioned in the job title.
# Warning: Any jobs without matching keywords in the job description will be skipped.
keywords_whitelist:

locations:
- Germany

Expand Down
5 changes: 5 additions & 0 deletions data_folder_example/work_preferences.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ date:
positions:
- Software engineer

# One or more keywords to look for in the job description, for example, "chromium browser". This field is optional.
# Only use this field to find jobs that require specific technologies, products, or skills that is not mentioned in the job title.
# Warning: Any jobs without matching keywords in the job description will be skipped.
keywords_whitelist:

locations:
- Germany

Expand Down
63 changes: 14 additions & 49 deletions CONTRIBUTING.md → docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

## Table of Contents

- [Issue Labels](#issue-labels)
- [Bug Reports](#bug-reports)
- [Feature Requests](#feature-requests)
- [Branch Rules](#branch-rules)
- [Version Control](#version-control)
- [Release Process](#release-process)
- [Roles](#roles)
- [Pull Request Process](#pull-request-process)
- [Code Style Guidelines](#code-style-guidelines)
- [Development Setup](#development-setup)
- [Testing](#testing)
- [Communication](#communication)
- [Development Diagrams](./docs/development_diagrams.md)
- [Contributing to Auto\_Jobs\_Applier\_AIHawk](#contributing-to-auto_jobs_applier_aihawk)
- [Table of Contents](#table-of-contents)
- [Issue Labels](#issue-labels)
- [Bug Reports](#bug-reports)
- [Feature Requests](#feature-requests)
- [Branch Rules](#branch-rules)
- [Version Control](#version-control)
- [Release Process](#release-process)
- [Pull Request Process](#pull-request-process)
- [Merging Pull Requests](#merging-pull-requests)
- [Code Style Guidelines](#code-style-guidelines)
- [Development Setup](#development-setup)
- [Testing](#testing)
- [Communication](#communication)

Thank you for your interest in contributing to Auto_Jobs_Applier_AIHawk. This document provides guidelines for contributing to the project.

Expand Down Expand Up @@ -114,42 +115,6 @@ gantt
Publish release/v4.1.0 :milestone, m4, 2025-02-03, 1d
```

## Roles

### Organization Owner

- Has full access to all repositories
- Controls organization-wide settings and permissions
- Can set base permissions for all members
- Manages repository settings and collaborator access

### Release Manager

- Creates and manages release branch from develop
- Coordinates release cycles and versioning
- Merges release into main

### Maintainer

- Reviews and approves develop, feature PRs
- Triage issues, bugs, PRs
- Manages feature, bugfix PRs merge into develop
- Leads feature development, bug prioritization
- Manages README, CONTRIBUTING, and other documentation

### Moderator

- Moderates Telegram, Discord channels
- Manages project wiki
- Contributes to README, CONTRIBUTING, and other documentation

### Contributor

- Creates feature branches from develop
- Implements new features, bug fixes, and other changes
- creates PRs on features
- Collaborates with other developers on features

## Pull Request Process

1. Fork the repository
Expand Down
Loading

0 comments on commit 84e3cea

Please sign in to comment.