Merge branch 'master' into replace-polyfill-io

Significant-Gravitas · Mar 8, 2024 · 3d5043a · 3d5043a
2 parents 38b5e7a + d5aa8d3
commit 3d5043a
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 34 deletions.
diff --git a/.github/workflows/arena-intake.yml b/.github/workflows/arena-intake.yml
@@ -125,7 +125,8 @@ jobs:
                 owner: context.repo.owner,
                 repo: context.repo.repo,
                 pull_number: pr.number,
-                team_reviewers: ['@Significant-Gravitas/maintainers'],
+                reviewers: ['Pwuts'],
+                // team_reviewers: ['maintainers'],  // doesn't work: https://stackoverflow.com/a/64977184/4751645
               });
             } else {
               console.log('➡️ Approving PR...');

diff --git a/.github/workflows/pr-label.yml b/.github/workflows/pr-label.yml
@@ -52,9 +52,6 @@ jobs:
           l_label: 'size/l'
           l_max_size: 500
           xl_label: 'size/xl'
-          message_if_xl: >
-            This PR exceeds the recommended size of 500 lines.
-            Please make sure you are NOT addressing multiple issues with one PR.
 
   scope:
     if: ${{ github.event_name == 'pull_request_target' }}

diff --git a/QUICKSTART.md b/QUICKSTART.md
@@ -77,37 +77,47 @@ After executing the above commands, running `./run setup` should work successful
 
 #### Store Project Files within the WSL File System
 If you continue to experience issues, consider storing your project files within the WSL file system instead of the Windows file system. This method avoids issues related to path translations and permissions and provides a more consistent development environment.
-
-    You can keep running the command to get feedback on where you are up to with your setup. 
-    When setup has been completed, the command will return an output like this:
 
-   ![Setup Complete](docs/content/imgs/quickstart/006_setup_complete.png)
+You can keep running the command to get feedback on where you are up to with your setup. 
+When setup has been completed, the command will return an output like this:
+
+![Setup Complete](docs/content/imgs/quickstart/006_setup_complete.png)
 
 ## Creating Your Agent
 
-    Now setup has been completed its time to create your agent template. 
-    Do so by running the `./run agent create YOUR_AGENT_NAME` replacing YOUR_AGENT_NAME with a name of your choice. Examples of valid names: swiftyosgpt or SwiftyosAgent or swiftyos_agent
-
-   ![Create an Agent](docs/content/imgs/quickstart/007_create_agent.png)
-
-    Upon creating your agent its time to officially enter the Arena!
-    Do so by running `./run arena enter YOUR_AGENT_NAME`
-
-   ![Enter the Arena](docs/content/imgs/quickstart/008_enter_arena.png)
-
-   > Note: for advanced users, create a new branch and create a file called YOUR_AGENT_NAME.json in the arena directory. Then commit this and create a PR to merge into the main repo. Only single file entries will be permitted. The json file needs the following format. 
-   ```json
-   {
-    "github_repo_url": "https://github.com/Swiftyos/YourAgentName",
-    "timestamp": "2023-09-18T10:03:38.051498",
-    "commit_hash_to_benchmark": "ac36f7bfc7f23ad8800339fa55943c1405d80d5e",
-    "branch_to_benchmark": "master"
-   }
-   ```
-   - github_repo_url: the url to your fork
-   - timestamp: timestamp of the last update of this file
-   - commit_hash_to_benchmark: the commit hash of your entry. You update each time you have an something ready to be officially entered into the hackathon
-   - branch_to_benchmark: the branch you are using to develop your agent on, default is master.
+After completing the setup, the next step is to create your agent template.
+Execute the command `./run agent create YOUR_AGENT_NAME`, where `YOUR_AGENT_NAME` should be replaced with a name of your choosing.
+
+Tips for naming your agent:
+* Give it its own unique name, or name it after yourself
+* Include an important aspect of your agent in the name, such as its purpose
+
+Examples: `SwiftyosAssistant`, `PwutsPRAgent`, `Narvis`, `evo.ninja`
+
+![Create an Agent](docs/content/imgs/quickstart/007_create_agent.png)
+
+### Optional: Entering the Arena
+
+Entering the Arena is an optional step intended for those who wish to actively participate in the agent leaderboard. If you decide to participate, you can enter the Arena by running `./run arena enter YOUR_AGENT_NAME`. This step is not mandatory for the development or testing of your agent.
+
+Entries with names like `agent`, `ExampleAgent`, `test_agent` or `MyExampleGPT` will NOT be merged. We also don't accept copycat entries that use the name of other projects, like `AutoGPT` or `evo.ninja`.
+
+![Enter the Arena](docs/content/imgs/quickstart/008_enter_arena.png)
+
+> **Note**  
+> For advanced users, create a new branch and create a file called YOUR_AGENT_NAME.json in the arena directory. Then commit this and create a PR to merge into the main repo. Only single file entries will be permitted. The json file needs the following format:
+> ```json
+> {
+>   "github_repo_url": "https://github.com/Swiftyos/YourAgentName",
+>   "timestamp": "2023-09-18T10:03:38.051498",
+>   "commit_hash_to_benchmark": "ac36f7bfc7f23ad8800339fa55943c1405d80d5e",
+>   "branch_to_benchmark": "master"
+> }
+> ```
+> - `github_repo_url`: the url to your fork
+> - `timestamp`: timestamp of the last update of this file
+> - `commit_hash_to_benchmark`: the commit hash of your entry. You update each time you have an something ready to be officially entered into the hackathon
+> - `branch_to_benchmark`: the branch you are using to develop your agent on, default is master.
 
 
 ## Running your Agent

diff --git a/README.md b/README.md
@@ -102,7 +102,11 @@ To maintain a uniform standard and ensure seamless compatibility with many curre
 ---
 
 <p align="center">
-  <a href="https://star-history.com/#Significant-Gravitas/AutoGPT&Date">
-    <img src="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date" alt="Star History Chart">
-  </a>
+<a href="https://star-history.com/#Significant-Gravitas/AutoGPT">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date&theme=dark" />
+    <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date" />
+    <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date" />
+  </picture>
+</a>
 </p>