Skip to content

Commit

Permalink
Merge pull request #908 from AIHawk-FOSS/ft_process_docs
Browse files Browse the repository at this point in the history
Ft process docs
  • Loading branch information
surapuramakhil authored Nov 23, 2024
2 parents 51fe7eb + e3c72d8 commit f2ae109
Show file tree
Hide file tree
Showing 6 changed files with 1,130 additions and 83 deletions.
681 changes: 649 additions & 32 deletions LICENSE

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,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 +763,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
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 f2ae109

Please sign in to comment.