Skip to content

docs: add system requirements section to README #10054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

chojuninengu
Copy link
Contributor

@chojuninengu chojuninengu commented May 27, 2025

This PR adds a comprehensive system requirements section to the README.md file. Currently, users don't have clear guidance on the hardware, software, and network requirements needed to run AutoGPT. This addition will help users determine if their system is capable of running AutoGPT before attempting installation.

Changes 🏗️

  • Added new "System Requirements" section under "How to Setup for Self-Hosting" with:
    • Hardware Requirements
      • CPU specifications (4+ cores)
      • RAM requirements (8GB min, 16GB recommended)
      • Storage requirements (10GB minimum)
    • Software Requirements
      • Supported Operating Systems
      • Required software with minimum versions
      • Development tools requirements
    • Network Requirements
      • Internet connectivity requirements
      • Port access information
      • HTTPS connection requirements

Checklist 📋

For code changes:

  • I have clearly listed my changes in the PR description
  • I have made a test plan
  • I have tested my changes according to the test plan:
    • Verified README.md renders correctly on GitHub
    • Confirmed all formatting is consistent
    • Validated all requirements are accurate
    • Checked section placement is logical
    • Ensured no other files are modified

For configuration changes:

  • Not applicable - This PR only contains documentation changes to README.md
  • No configuration files are modified in this update

@chojuninengu chojuninengu requested a review from a team as a code owner May 27, 2025 16:15
@chojuninengu chojuninengu requested review from Bentlybro and kcze and removed request for a team May 27, 2025 16:15
@github-project-automation github-project-automation bot moved this to 🆕 Needs initial review in AutoGPT development kanban May 27, 2025
Copy link
Contributor

This PR targets the master branch but does not come from dev or a hotfix/* branch.

Automatically setting the base branch to dev.

@github-actions github-actions bot changed the base branch from master to dev May 27, 2025 16:15
@github-actions github-actions bot added platform/backend AutoGPT Platform - Back end size/m labels May 27, 2025
Copy link

netlify bot commented May 27, 2025

Deploy Preview for auto-gpt-docs canceled.

Name Link
🔨 Latest commit 30965f3
🔍 Latest deploy log https://app.netlify.com/projects/auto-gpt-docs/deploys/683db81c8ceedd0008ac06f1

@chojuninengu
Copy link
Contributor Author

@Bentlybro , this one is clean

Copy link

deepsource-io bot commented May 27, 2025

Here's the code health analysis summary for commits 768c6b1..30965f3. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource JavaScript LogoJavaScript✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@AutoGPT-Agent
Copy link

Thank you for adding the system requirements to the README.md. This is a valuable addition that will help users determine if their system is compatible with AutoGPT before installation.

However, I noticed that this PR contains significant backend code changes that aren't related to the README documentation update:

  1. Changes to backend/executor/manager.py including new threading logic and error handling
  2. Modifications to backend/server/routers/v1.py
  3. Addition of a new continuous_retry function in backend/util/retry.py

These backend code changes aren't mentioned in your PR description, which only discusses README.md documentation changes. According to our contribution guidelines, all changes should be covered by the PR description, and maximum 20% of changes can be out of scope from the PR title.

Please do one of the following:

  • Remove the backend code changes and submit them in a separate PR with an appropriate title and description
  • Update this PR's title and description to accurately reflect all the changes being made

Once addressed, this PR can be reconsidered for merging.

@AutoGPT-Agent
Copy link

Thank you for adding the system requirements to the README! This is a useful addition that will help users understand what they need before attempting to install AutoGPT.

However, I noticed this PR includes several backend code changes that weren't mentioned in your PR description:

  1. Changes to backend/executor/manager.py including:
  • Adding a new continuous retry mechanism
  • Refactoring message consumption into separate methods
  • Changes to error handling and cleanup logic
  1. Changes to backend/server/routers/v1.py adding a health_check=False parameter

  2. Addition of a new continuous_retry() function in backend/util/retry.py

Since your PR title and description only mention README changes, these code modifications are unexpected. Could you please:

  1. Update your PR title and description to include these backend changes, or
  2. Remove these backend code changes and submit them as a separate PR

For option 1, you'll need to:

  • Change the PR title to include the backend changes (following conventional commit format)
  • Update the description to explain the purpose of these backend modifications
  • Verify the changes have been properly tested

Looking forward to your updates!

@Pwuts Pwuts changed the title docs: add system requirements section to README (#10050) docs: add system requirements section to README May 27, 2025
@AutoGPT-Agent
Copy link

Thank you for adding the system requirements section to the README - this is a useful addition for users.

However, I notice that this PR contains significant backend code changes that aren't mentioned in the PR title or description:

  1. Changes to backend/executor/manager.py including:

    • Adding a new continuous_retry function import
    • Refactoring execution consumer handling
    • Modifications to cleanup behavior
  2. Changes to backend/server/routers/v1.py with a parameter modification

  3. Addition of a new continuous_retry function in backend/util/retry.py

These backend changes need to be:

  1. Reflected in the PR title (which currently only mentions documentation changes)
  2. Explained in the PR description
  3. Covered by appropriate test plans

Please either:

  • Remove the backend code changes and keep only the README modifications
  • Update the PR title and description to accurately reflect all changes being made, with proper test plans for the backend modifications

Once the PR accurately represents the actual changes being made, we can proceed with the review.

@Pwuts Pwuts force-pushed the readme-requirements-clean branch from b1a9f47 to 96d973b Compare May 27, 2025 16:20
Copy link

netlify bot commented May 27, 2025

Deploy Preview for auto-gpt-docs-dev canceled.

Name Link
🔨 Latest commit 30965f3
🔍 Latest deploy log https://app.netlify.com/projects/auto-gpt-docs-dev/deploys/683db81c8e8e7800085025c9

@AutoGPT-Agent
Copy link

Thank you for adding the system requirements section to the README. This documentation addition will certainly help users understand what they need before attempting to install AutoGPT.

However, I notice this PR includes substantial backend code changes that aren't mentioned in the title or description:

  1. Added a new continuous_retry() function in the retry.py file
  2. Refactored the GraphExecutorService class in manager.py with significant changes to how consumers work
  3. Modified the error handling and process management in the executor
  4. Changed the execution_scheduler_client() function in v1.py

These backend changes appear unrelated to the README documentation update and make up the majority of the changes in this PR.

To proceed, you should either:

  1. Split this into two separate PRs:

    • One for the README documentation update (current title is appropriate)
    • A separate PR for the backend changes with an appropriate title like fix: or refactor: improve retry handling in executor service
  2. Or if these changes are intentionally packaged together:

    • Update the PR title to reflect both sets of changes (e.g., "docs+fix: add system requirements to README and improve executor retry handling")
    • Explain in the PR description what these backend changes accomplish and why they're included

The README changes look good on their own, but we need to address the scope mismatch with the backend changes before this can be merged.

Copy link
Member

@Bentlybro Bentlybro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this! it looks good to me.

@github-project-automation github-project-automation bot moved this from 🆕 Needs initial review to 👍🏼 Mergeable in AutoGPT development kanban May 27, 2025
@chojuninengu
Copy link
Contributor Author

@kcze , what's your take on this pull request, should I update anything there, or its okay for now?

@Bentlybro
Copy link
Member

Hey this PR is ready to merge!

@Bentlybro Bentlybro added this pull request to the merge queue Jun 2, 2025
Merged via the queue into Significant-Gravitas:dev with commit 0ec557b Jun 2, 2025
21 checks passed
@github-project-automation github-project-automation bot moved this from 👍🏼 Mergeable to ✅ Done in AutoGPT development kanban Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
platform/backend AutoGPT Platform - Back end size/m
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants