From 66f373fb57a5184b62101e39041a900f89526212 Mon Sep 17 00:00:00 2001 From: Reinier van der Leer Date: Fri, 14 Jun 2024 07:44:04 -0700 Subject: [PATCH] docs: Update CONTRIBUTING.md - Add reference to Code Guidelines - Reorder list of directives to more logical order --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1cfa46467..9e083c570 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ # AutoGPT Contribution Guide -If you are reading this, you are probably looking for our **[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. @@ -15,15 +15,17 @@ Also check out our [🚀 Roadmap][roadmap] for information about our priorities 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]. -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. +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).