mirror of
https://github.com/Significant-Gravitas/Auto-GPT.git
synced 2025-01-09 04:19:02 +08:00
d42ed088dd
* Update files via upload * Update README.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md
42 lines
2.4 KiB
Markdown
42 lines
2.4 KiB
Markdown
# 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]. -->
|
|
|
|
[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
|
|
[kanban board]: https://github.com/orgs/Significant-Gravitas/projects/1
|
|
|
|
## 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.
|
|
|
|
## In short
|
|
1. Avoid duplicate work, issues, PRs etc.
|
|
2. We encourage you to collaborate with fellow community members on some of our bigger
|
|
[todo's][roadmap]!
|
|
* 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]
|
|
5. Clearly explain your changes when submitting a PR.
|
|
6. Don't submit broken code: test/validate your changes.
|
|
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.
|
|
|
|
[dev channel]: https://discord.com/channels/1092243196446249134/1095817829405704305
|
|
[code guidelines]: https://github.com/Significant-Gravitas/AutoGPT/wiki/Contributing#code-guidelines
|
|
|
|
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).
|
|
|
|
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
|
|
https://discord.gg/autogpt
|