Auto-GPT/CONTRIBUTING.md

42 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

# AutoGPT Contribution Guide
If you are reading this, you are probably looking for the full **[contribution guide]**,
which is part of our [wiki].
Also check out our [🚀 Roadmap][roadmap] for information about our priorities and associated tasks.
<!-- You can find our immediate priorities and their progress on our public [kanban board]. -->
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 21:59:17 +08:00
[contribution guide]: https://github.com/Significant-Gravitas/AutoGPT/wiki/Contributing
[wiki]: https://github.com/Significant-Gravitas/AutoGPT/wiki
[roadmap]: https://github.com/Significant-Gravitas/AutoGPT/discussions/6971
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 21:59:17 +08:00
[kanban board]: https://github.com/orgs/Significant-Gravitas/projects/1
2024-09-25 06:16:24 +08:00
## Contributing to the AutoGPT Platform Folder
All contributions to [the autogpt_platform folder](https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpt_platform) will be under our [Contribution License Agreement](https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpt_platform/Contributor%20License%20Agreement%20(CLA).md). By making a pull request contributing to this folder, you agree to the terms of our CLA for your contribution. All contributions to other folders will be under the MIT license.
2024-09-25 06:16:24 +08:00
2023-09-06 11:05:55 +08:00
## In short
1. Avoid duplicate work, issues, PRs etc.
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 21:59:17 +08:00
2. We encourage you to collaborate with fellow community members on some of our bigger
[todo's][roadmap]!
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 21:59:17 +08:00
* We highly recommend to post your idea and discuss it in the [dev channel].
3. Create a draft PR when starting work on bigger changes.
4. Adhere to the [Code Guidelines]
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 21:59:17 +08:00
5. Clearly explain your changes when submitting a PR.
6. Don't submit broken code: test/validate your changes.
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 21:59:17 +08:00
7. Avoid making unnecessary changes, especially if they're purely based on your personal
preferences. Doing so is the maintainers' job. ;-)
8. Please also consider contributing something other than code; see the
[contribution guide] for options.
2023-09-06 11:05:55 +08:00
[dev channel]: https://discord.com/channels/1092243196446249134/1095817829405704305
[code guidelines]: https://github.com/Significant-Gravitas/AutoGPT/wiki/Contributing#code-guidelines
2023-09-06 11:05:55 +08:00
If you wish to involve with the project (beyond just contributing PRs), please read the
wiki page about [Catalyzing](https://github.com/Significant-Gravitas/AutoGPT/wiki/Catalyzing).
2023-09-06 11:05:55 +08:00
In fact, why not just look through the whole wiki (it's only a few pages) and
hop on our Discord. See you there! :-)
❤️ & 🔆
The team @ AutoGPT
2023-09-06 11:05:55 +08:00
https://discord.gg/autogpt