AutoGPT/CONTRIBUTING.md

35 lines
1.5 KiB
Markdown
Raw Normal View History

# AutoGPT Contribution Guide
2023-09-06 03:05:55 +00:00
If you are reading this, you are probably looking for our **[contribution guide]**,
which is part of our [knowledge base].
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 13:59:17 +00:00
You can find our immediate priorities and their progress on our public [kanban board].
2023-09-06 03:05:55 +00:00
[contribution guide]: https://github.com/Significant-Gravitas/Nexus/wiki/Contributing
[knowledge base]: https://github.com/Significant-Gravitas/Nexus/wiki
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 13:59:17 +00:00
[kanban board]: https://github.com/orgs/Significant-Gravitas/projects/1
2023-09-06 03:05:55 +00: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 13:59:17 +00:00
2. We encourage you to collaborate with fellow community members on some of our bigger
[todo's][kanban board]!
* We highly recommend to post your idea and discuss it in the [dev channel].
4. Create a draft PR when starting work on bigger changes.
3. Please also consider contributing something other than code; see the
[contribution guide] for options.
5. Clearly explain your changes when submitting a PR.
6. Don't submit stuff that's broken.
7. Avoid making unnecessary changes, especially if they're purely based on your personal
preferences. Doing so is the maintainers' job. ;-)
2023-09-06 03:05:55 +00:00
[dev channel]: https://discord.com/channels/1092243196446249134/1095817829405704305
2023-09-06 03:05:55 +00:00
If you wish to involve with the project (beyond just contributing PRs), please read the
wiki [catalyzing](https://github.com/Significant-Gravitas/Nexus/wiki/Catalyzing) page.
In fact, why not just look through the whole wiki (it's only a few pages) and
hop on our Discord. See you there! :-)
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 13:59:17 +00:00
❤️ & 🔆
The team @ AutoGPT
2023-09-06 03:05:55 +00:00
https://discord.gg/autogpt