Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 5.23 KB

CONTRIBUTING.md

File metadata and controls

79 lines (52 loc) · 5.23 KB
Raw

⚡ Contributing to SuperAGI

SuperAGI logo SuperAGI logo

First of all, thank you for taking the time to contribute to this project. We truly appreciate your contributions, whether it's bug reports, feature suggestions, or pull requests. Your time and effort are highly valued in this project. 🚀

This document provides guidelines and best practices to help you to contribute effectively. These are meant to serve as guidelines, not strict rules. We encourage you to use your best judgment and feel comfortable proposing changes to this document through a pull request.

For all contributions, a CLA (Contributor License Agreement) needs to be signed here before (or after) the pull request has been submitted.

Table of Content:

  1. Code of conduct
  2. Quick Start
  3. Contributing Guidelines
    1. Reporting Bugs
    2. New Feature or Suggesting Enhancements
  4. Testing
  5. Pull Requests

✔️ Code of Conduct:

Please read our Code of Conduct to understand the expectations we have for all contributors participating in this project. By participating, you agree to abide by our Code of Conduct.

🚀 Quick Start

You can quickly get started with contributing by searching for issues with the labels "Good First Issue" or "Help Needed" in the Issues Section. If you think you can contribute, comment on the issue and we will assign it to you.

To set up your development environment, please follow the steps mentioned below :

  1. Fork the repository and create a clone of the fork
  2. Create a branch for a feature or a bug you are working on in your fork
  3. Once you've created your branch, follow the instructions in the README.MD

Contributing Guidelines

🔍 Reporting Bugs

You can start working on an existing bug that has been reported and labeled as "Bug" in the Issues Section, and you can report your bugs in the following manner :

  1. Title describing the issue clearly and concisely with relevant labels
  2. Provide a detailed description of the problem and the necessary steps to reproduce the issue.
  3. Include any relevant logs, screenshots, or other helpful information supporting the issue.

💡 New Feature or Suggesting Enhancements

This section guides you through working on an enhancement Including a completely New Feature & Enhancements to an existing functionality.

Before getting started, Perform a search on Issues to see if the enhancement or feature has already been suggested and picked up. If the feature or enhancement is suggested and not picked up, comment on the issue and assign yourself to it.

If the feature or enhancement is not in the issues, find out whether your idea fits with the scope and aims of the project by looking at the Roadmap. If yes, raise an issue with the label "Feature Request" in the following manner:

  1. Title describing the feature or enhancement in a clear and concise manner
  2. Clearly describe the proposed enhancement, highlighting its benefits and potential drawbacks.
  3. Provide examples and supporting information.

Once you have raised the issue and have gotten yourself assigned, you can start working on the feature or enhancement. Please make sure the feature or enhancement you're working on is placed on the Roadmap.

Testing your Changes

Each method or the function of the code should have a unit test with the maximum coverage possible and on each Pull Request, we have GitHub Actions triggered, which runs all the unit tests where all the tests should pass for merging the Pull Request.

Pull Request

Now that you have worked on your code and tested it thoroughly, you can now go ahead and raise the pull request. Please make sure that the Pull Request adheres to the following guidelines:

  1. The pull request is atomic and focuses on a single change.
  2. You have read the contributing guide and your code conforms to the guidelines.
  3. You have documented your changes clearly and comprehensively.
  4. You have added the required tests.