-
Notifications
You must be signed in to change notification settings - Fork 44.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into download-files-again
- Loading branch information
Showing
61 changed files
with
1,426 additions
and
359 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: Docker Image CI | ||
|
||
on: | ||
push: | ||
branches: [ "master" ] | ||
pull_request: | ||
branches: [ "master" ] | ||
|
||
jobs: | ||
|
||
build: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Build the Docker image | ||
run: docker build . --file Dockerfile --tag autogpt:$(date +%s) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: Push Docker Image on Release | ||
|
||
on: | ||
push: | ||
branches: [ "stable" ] | ||
|
||
jobs: | ||
|
||
build: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Log in to Docker hub | ||
env: | ||
DOCKER_USER: ${{secrets.DOCKER_USER}} | ||
DOCKER_PASSWORD: ${{secrets.DOCKER_PASSWORD}} | ||
run: | | ||
docker login -u $DOCKER_USER -p $DOCKER_PASSWORD | ||
- name: Build the Docker image | ||
run: docker build . --file Dockerfile --tag ${{secrets.DOCKER_USER}}/auto-gpt:$(git describe --tags `git rev-list --tags --max-count=1`) | ||
- name: Docker Push | ||
run: docker push ${{secrets.DOCKER_USER}}/auto-gpt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Code of Conduct for auto-gpt | ||
|
||
## 1. Purpose | ||
|
||
The purpose of this Code of Conduct is to provide guidelines for contributors to the auto-gpt project on GitHub. We aim to create a positive and inclusive environment where all participants can contribute and collaborate effectively. By participating in this project, you agree to abide by this Code of Conduct. | ||
|
||
## 2. Scope | ||
|
||
This Code of Conduct applies to all contributors, maintainers, and users of the auto-gpt project. It extends to all project spaces, including but not limited to issues, pull requests, code reviews, comments, and other forms of communication within the project. | ||
|
||
## 3. Our Standards | ||
|
||
We encourage the following behavior: | ||
|
||
* Being respectful and considerate to others | ||
* Actively seeking diverse perspectives | ||
* Providing constructive feedback and assistance | ||
* Demonstrating empathy and understanding | ||
|
||
We discourage the following behavior: | ||
|
||
* Harassment or discrimination of any kind | ||
* Disrespectful, offensive, or inappropriate language or content | ||
* Personal attacks or insults | ||
* Unwarranted criticism or negativity | ||
|
||
## 4. Reporting and Enforcement | ||
|
||
If you witness or experience any violations of this Code of Conduct, please report them to the project maintainers by email or other appropriate means. The maintainers will investigate and take appropriate action, which may include warnings, temporary or permanent bans, or other measures as necessary. | ||
|
||
Maintainers are responsible for ensuring compliance with this Code of Conduct and may take action to address any violations. | ||
|
||
## 5. Acknowledgements | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html). | ||
|
||
## 6. Contact | ||
|
||
If you have any questions or concerns, please contact the project maintainers. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,64 +1,99 @@ | ||
# Contributing to ProjectName | ||
|
||
To contribute to this GitHub project, you can follow these steps: | ||
First of all, thank you for considering contributing to our project! We appreciate your time and effort, and we value any contribution, whether it's reporting a bug, suggesting a new feature, or submitting a pull request. | ||
|
||
1. Fork the repository you want to contribute to by clicking the "Fork" button on the project page. | ||
This document provides guidelines and best practices to help you contribute effectively. | ||
|
||
2. Clone the repository to your local machine using the following command: | ||
## Table of Contents | ||
|
||
``` | ||
git clone https://github.com/<YOUR-GITHUB-USERNAME>/Auto-GPT | ||
``` | ||
3. Install the project requirements | ||
``` | ||
pip install -r requirements.txt | ||
``` | ||
4. Install pre-commit hooks | ||
``` | ||
pre-commit install | ||
``` | ||
5. Create a new branch for your changes using the following command: | ||
- [Code of Conduct](#code-of-conduct) | ||
- [Getting Started](#getting-started) | ||
- [How to Contribute](#how-to-contribute) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Suggesting Enhancements](#suggesting-enhancements) | ||
- [Submitting Pull Requests](#submitting-pull-requests) | ||
- [Style Guidelines](#style-guidelines) | ||
- [Code Formatting](#code-formatting) | ||
- [Pre-Commit Hooks](#pre-commit-hooks) | ||
|
||
``` | ||
git checkout -b "branch-name" | ||
``` | ||
6. Make your changes to the code or documentation. | ||
- Example: Improve User Interface or Add Documentation. | ||
## Code of Conduct | ||
|
||
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand the expectations we have for everyone who contributes to this project. | ||
|
||
7. Add the changes to the staging area using the following command: | ||
``` | ||
git add . | ||
``` | ||
## Getting Started | ||
|
||
8. Commit the changes with a meaningful commit message using the following command: | ||
``` | ||
git commit -m "your commit message" | ||
``` | ||
9. Push the changes to your forked repository using the following command: | ||
``` | ||
git push origin branch-name | ||
``` | ||
10. Go to the GitHub website and navigate to your forked repository. | ||
To start contributing, follow these steps: | ||
|
||
1. Fork the repository and clone your fork. | ||
2. Create a new branch for your changes (use a descriptive name, such as `fix-bug-123` or `add-new-feature`). | ||
3. Make your changes in the new branch. | ||
4. Test your changes thoroughly. | ||
5. Commit and push your changes to your fork. | ||
6. Create a pull request following the guidelines in the [Submitting Pull Requests](#submitting-pull-requests) section. | ||
|
||
## How to Contribute | ||
|
||
11. Click the "New pull request" button. | ||
### Reporting Bugs | ||
|
||
12. Select the branch you just pushed to and the branch you want to merge into on the original repository. | ||
If you find a bug in the project, please create an issue on GitHub with the following information: | ||
|
||
13. Add a description of your changes and click the "Create pull request" button. | ||
- A clear, descriptive title for the issue. | ||
- A description of the problem, including steps to reproduce the issue. | ||
- Any relevant logs, screenshots, or other supporting information. | ||
|
||
14. Wait for the project maintainer to review your changes and provide feedback. | ||
### Suggesting Enhancements | ||
|
||
15. Make any necessary changes based on feedback and repeat steps 5-12 until your changes are accepted and merged into the main project. | ||
If you have an idea for a new feature or improvement, please create an issue on GitHub with the following information: | ||
|
||
16. Once your changes are merged, you can update your forked repository and local copy of the repository with the following commands: | ||
- A clear, descriptive title for the issue. | ||
- A detailed description of the proposed enhancement, including any benefits and potential drawbacks. | ||
- Any relevant examples, mockups, or supporting information. | ||
|
||
### Submitting Pull Requests | ||
|
||
When submitting a pull request, please ensure that your changes meet the following criteria: | ||
|
||
- Your pull request should be atomic and focus on a single change. | ||
- Your pull request should include tests for your change. | ||
- You should have thoroughly tested your changes with multiple different prompts. | ||
- You should have considered potential risks and mitigations for your changes. | ||
- You should have documented your changes clearly and comprehensively. | ||
- You should not include any unrelated or "extra" small tweaks or changes. | ||
|
||
## Style Guidelines | ||
|
||
### Code Formatting | ||
|
||
We use the `black` code formatter to maintain a consistent coding style across the project. Please ensure that your code is formatted using `black` before submitting a pull request. You can install `black` using `pip`: | ||
|
||
```bash | ||
pip install black | ||
``` | ||
git fetch upstream | ||
git checkout master | ||
git merge upstream/master | ||
|
||
To format your code, run the following command in the project's root directory: | ||
|
||
```bash | ||
black . | ||
``` | ||
Finally, delete the branch you created with the following command: | ||
### Pre-Commit Hooks | ||
We use pre-commit hooks to ensure that code formatting and other checks are performed automatically before each commit. To set up pre-commit hooks for this project, follow these steps: | ||
|
||
Install the pre-commit package using pip: | ||
```bash | ||
pip install pre-commit | ||
``` | ||
git branch -d branch-name | ||
|
||
Run the following command in the project's root directory to install the pre-commit hooks: | ||
```bash | ||
pre-commit install | ||
``` | ||
That's it you made it 🐣⭐⭐ | ||
|
||
Now, the pre-commit hooks will run automatically before each commit, checking your code formatting and other requirements. | ||
|
||
If you encounter any issues or have questions, feel free to reach out to the maintainers or open a new issue on GitHub. We're here to help and appreciate your efforts to contribute to the project. | ||
|
||
Happy coding, and once again, thank you for your contributions! | ||
|
||
Maintainers will look at PR that have no merge conflicts when deciding what to add to the project. Make sure your PR shows up here: | ||
|
||
https://github.com/Torantulino/Auto-GPT/pulls?q=is%3Apr+is%3Aopen+-is%3Aconflict+ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.