ada6990fd0
+ add templates: bug, feature, pull request, docs and config
--- ATTENTION: docs.yml has to be modified due to lot of unknown from me
These are put inside { ... }
3.2 KiB
Contributing to AgentGPT
First of all, thank you for your interest in contributing to AgentGPT! We appreciate the time and effort you're willing to invest in making our project better. This document provides guidelines and information to make the contribution process as smooth as possible.
Table of Contents
Code of Conduct
All contributors are expected to adhere to our Code of Conduct. Please read it before participating in the AgentGPT community.
Getting Started
- Fork the repository and clone it to your local machine.
- Set up the development environment by following the instructions in the README.md file.
- Explore the codebase, run tests, and verify that everything works as expected.
How to Contribute
Reporting Bugs
If you encounter a bug or issue while using AgentGPT, please open a new issue on the GitHub Issues page. Provide a clear and concise description of the problem, steps to reproduce it, and any relevant error messages or logs.
Suggesting Enhancements
We welcome ideas for improvements and new features. To suggest an enhancement, open a new issue on the GitHub Issues page. Describe the enhancement in detail, explain the use case, and outline the benefits it would bring to the project.
Submitting Pull Requests
- Create a new branch for your feature or bugfix. Use a descriptive name like
feature/your-feature-nameorfix/your-bugfix-name. - Make your changes, following the Style Guidelines below.
- Test your changes and ensure that they don't introduce new issues or break existing functionality.
- Commit your changes, following the commit message guidelines.
- Push your branch to your fork on GitHub.
- Open a new pull request against the
mainbranch of the Wolverine repository. Include a clear and concise description of your changes, referencing any related issues.
Style Guidelines
Code Style
AgentGPT uses ESLint as its code style guide. Please ensure that your code follows these guidelines.
Commit Messages
Write clear and concise commit messages that briefly describe the changes made in each commit. Use the imperative mood and start with a capitalized verb, e.g., "Add new feature" or "Fix bug in function".
Additional Resources
Thank you once again for your interest in contributing to AgentGPT. We look forward to collaborating with you and creating an even better project together!